delete #

Deletes a document.

:::: tabs ::: tab Java

Arguments #

public CompletableFuture<Map<String, Object>> delete(
      String index,
      String collection,
      String id)
throws NotConnectedException, InternalException

public CompletableFuture<Map<String, Object>> delete(
      String index,
      String collection,
      String id,
      Boolean waitForRefresh)
throws NotConnectedException, InternalException

Arguments	Type	Description
`index`	String	Index
`collection`	String	Collection
`id`	String	Document ID
`waitForRefresh`	Boolean (optional)	If set to `true`, Kuzzle will wait for the persistence layer to finish indexing

Return #

A Map which has the following property:

Property	Type	Description
`_id`	String	ID of the deleted document

Usage #

kuzzle.getDocumentController().delete("nyc-open-data", "yellow-taxi", "some-id")
.get();

::: ::: tab Kotlin

Arguments #

fun delete(
      index: String,
      collection: String,
      id: String?,
      waitForRefresh: Boolean? = null): CompletableFuture<Map<String, Any?>>

Arguments	Type	Description
`index`	String	Index
`collection`	String	Collection
`id`	String	Document ID
`waitForRefresh`	Boolean (optional)	If set to `true`, Kuzzle will wait for the persistence layer to finish indexing

Return #

A Map which has the following property:

Property	Type	Description
`_id`	String	ID of the deleted document

Usage #

kuzzle
  .documentController
  .delete("nyc-open-data", "yellow-taxi", "some-id")
  .get();

::: ::::

Edit this page on Github