honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 10:25:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

add timeout doc to delete

Browse Source
This commit is contained in:
Shay Banon 2013-11-20 12:50:03 -08:00
parent f465a6b589
commit a9880dcbf1
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/reference/docs/delete.asciidoc
View File

@ -121,3 +121,21 @@ relevant shard after the delete operation has occurred and make it
searchable. Setting it to `true` should be done after careful thought
and verification that this does not cause a heavy load on the system
(and slows down indexing).
[float]
[[timeout]]
=== Timeout
The primary shard assigned to perform the delete operation might not be
available when the delete operation is executed. Some reasons for this
might be that the primary shard is currently recovering from a gateway
or undergoing relocation. By default, the delete operation will wait on
the primary shard to become available for up to 1 minute before failing
and responding with an error. The `timeout` parameter can be used to
explicitly specify how long it waits. Here is an example of setting it
to 5 minutes:
[source,js]
--------------------------------------------------
$ curl -XDELETE 'http://localhost:9200/twitter/tweet/1?timeout=5m'
--------------------------------------------------