Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 985 Bytes

File metadata and controls

42 lines (29 loc) · 985 Bytes
code type title description
true
page
DeleteAsync
Deletes a document from kuzzle.

DeleteAsync

Deletes a document.

Arguments

public async Task<string> DeleteAsync(
  string index, 
  string collection, 
  string id, 
  bool waitForRefresh = false);

Argument Type Description
index
string
Index name
collection
string
Collection name
id
string
Document ID
waitForRefresh
bool

(false)
If true, waits for the change to be reflected for search (up to 1s)

Return

The ID of the deleted document.

Exceptions

Throws a KuzzleException if there is an error. See how to handle errors.

Usage

<<< ./snippets/delete.cs