summaryrefslogtreecommitdiff
path: root/docs/java-api/delete.asciidoc
diff options
context:
space:
mode:
authorHilko Bengen <bengen@debian.org>2014-06-07 12:02:12 +0200
committerHilko Bengen <bengen@debian.org>2014-06-07 12:02:12 +0200
commitd5ed89b946297270ec28abf44bef2371a06f1f4f (patch)
treece2d945e4dde69af90bd9905a70d8d27f4936776 /docs/java-api/delete.asciidoc
downloadelasticsearch-d5ed89b946297270ec28abf44bef2371a06f1f4f.tar.gz
Imported Upstream version 1.0.3upstream/1.0.3
Diffstat (limited to 'docs/java-api/delete.asciidoc')
-rw-r--r--docs/java-api/delete.asciidoc40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/java-api/delete.asciidoc b/docs/java-api/delete.asciidoc
new file mode 100644
index 0000000..409b5be
--- /dev/null
+++ b/docs/java-api/delete.asciidoc
@@ -0,0 +1,40 @@
+[[delete]]
+== Delete API
+
+The delete API allows to delete a typed JSON document from a specific
+index based on its id. The following example deletes the JSON document
+from an index called twitter, under a type called tweet, with id valued
+1:
+
+[source,java]
+--------------------------------------------------
+DeleteResponse response = client.prepareDelete("twitter", "tweet", "1")
+ .execute()
+ .actionGet();
+--------------------------------------------------
+
+For more information on the delete operation, check out the
+{ref}/docs-delete.html[delete API] docs.
+
+
+[[operation-threading]]
+=== Operation Threading
+
+The delete API allows to set the threading model the operation will be
+performed when the actual execution of the API is performed on the same
+node (the API is executed on a shard that is allocated on the same
+server).
+
+The options are to execute the operation on a different thread, or to
+execute it on the calling thread (note that the API is still async). By
+default, `operationThreaded` is set to `true` which means the operation
+is executed on a different thread. Here is an example that sets it to
+`false`:
+
+[source,java]
+--------------------------------------------------
+DeleteResponse response = client.prepareDelete("twitter", "tweet", "1")
+ .setOperationThreaded(false)
+ .execute()
+ .actionGet();
+--------------------------------------------------