Skip to content

Commit

Permalink
[DOCS] Rebuild auto-generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
polyfractal committed May 9, 2016
1 parent 8a0a932 commit 2904d7a
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 2 deletions.
27 changes: 27 additions & 0 deletions docs/build/Elasticsearch/Client.asciidoc
Expand Up @@ -32,6 +32,7 @@ The class defines the following methods:
* <<Elasticsearch_Clientcreate_create,`create()`>>
* <<Elasticsearch_Clientbulk_bulk,`bulk()`>>
* <<Elasticsearch_Clientindex_index,`index()`>>
* <<Elasticsearch_Clientreindex_reindex,`reindex()`>>
* <<Elasticsearch_Clientsuggest_suggest,`suggest()`>>
* <<Elasticsearch_Clientexplain_explain,`explain()`>>
* <<Elasticsearch_Clientsearch_search,`search()`>>
Expand Down Expand Up @@ -624,6 +625,32 @@ $response = $client->index($params);



[[Elasticsearch_Clientreindex_reindex]]
.`reindex()`
****
[source,php]
----
/*
$params['refresh'] = (boolean) Should the effected indexes be refreshed?
['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable
['consistency'] = (enum) Explicit write consistency setting for the operation
['wait_for_completion'] = (boolean) Should the request should block until the reindex is complete
['requests_per_second'] = (float) The throttle for this request in sub-requests per second. 0 means set no throttle
['body'] = (array) The search definition using the Query DSL and the prototype for the index request (Required)
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->reindex($params);
----
****



[[Elasticsearch_Clientsuggest_suggest]]
.`suggest()`
****
Expand Down
26 changes: 26 additions & 0 deletions docs/build/Elasticsearch/Namespaces/CatNamespace.asciidoc
Expand Up @@ -30,6 +30,7 @@ The class defines the following methods:
* <<Elasticsearch_Namespaces_CatNamespacefielddata_fielddata,`fielddata()`>>
* <<Elasticsearch_Namespaces_CatNamespaceplugins_plugins,`plugins()`>>
* <<Elasticsearch_Namespaces_CatNamespacesegments_segments,`segments()`>>
* <<Elasticsearch_Namespaces_CatNamespacetasks_tasks,`tasks()`>>



Expand Down Expand Up @@ -399,6 +400,7 @@ $params['local'] = (bool) Return local information, do not retrieve the
['help'] = (bool) Return help information
['v'] = (bool) Verbose mode. Display column headers
['full_id'] = (bool) Enables displaying the complete node ids
['size'] = (enum) The multiplier in which to display values ([ "", "k", "m", "g", "t", "p" ])
['body'] = (array) Request body
*/
Expand Down Expand Up @@ -487,3 +489,27 @@ $response = $client->cat()->segments($params);
****



[[Elasticsearch_Namespaces_CatNamespacetasks_tasks]]
.`tasks()`
****
[source,php]
----
/*
$params['format'] = (string) a short version of the Accept header, e.g. json, yaml
['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
['format'] = (string) a short version of the Accept header, e.g. json, yaml
['actions'] = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->cat()->tasks($params);
----
****


Expand Up @@ -830,12 +830,16 @@ $response = $client->indices()->open($params);
$params['index'] = (string) The name of the index to scope the operation
['analyzer'] = (string) The name of the analyzer to use
['field'] = (string) Use the analyzer configured for this field (instead of passing the analyzer name)
['filters'] = (list) A comma-separated list of filters to use for the analysis
['filter'] = (list) A comma-separated list of filters to use for the analysis
['prefer_local'] = (boolean) With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
['text'] = (string) The text on which the analysis should be performed (when request body is not used)
['tokenizer'] = (string) The name of the tokenizer to use for the analysis
['format'] = (enum) Format of the output
['body'] = (enum) Format of the output
['char_filter'] = (list) A comma-separated list of character filters to use for the analysis
['explain'] = (bool) With `true`, outputs more advanced details. (default: false)
['attributes'] = (list) A comma-separated list of token attributes to output, this parameter works only with `explain=true`
['format'] = (enum) Format of the output (["detailed", "text"])
['body'] = (array) Request body
*/
Expand Down
2 changes: 1 addition & 1 deletion docs/build/renderer.index
@@ -1 +1 @@
C:19:"Sami\Renderer\Index":944:{a:3:{i:0;a:9:{s:20:"Elasticsearch\Client";s:40:"1eaf0f437ee80b6c3e4f5accef52a797bb1eefba";s:27:"Elasticsearch\ClientBuilder";s:40:"d78dc3bb58ca7bd920ae7af1745004176a8e5063";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"75993a58bbc5c96c6be89af386b40792729b7d94";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"0b6b06bb1d8486e9a4c00e7e8b3da30f10be0a2a";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"9aa2dbdf7a9a1e857f65a4b9ee612f9bcf70892d";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"0d541617b01a75f1e615f35f8202e1747384f5b5";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"fafd30cdb7e0c546217d8bd7aae493ad701f385c";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"f2ec6976856d2d06ab29684c982f8e41ac68de5d";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"766f7580c3df06c4369b4bcb82a630ec7d8a2a35";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}}
C:19:"Sami\Renderer\Index":944:{a:3:{i:0;a:9:{s:20:"Elasticsearch\Client";s:40:"04f5d259604eefa88dc21968baccf069816c5924";s:27:"Elasticsearch\ClientBuilder";s:40:"43909299261f400333c723060331bedf4d90e098";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"12e07e6eeeef76765996f6133f85dcb7b4046960";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"0b6b06bb1d8486e9a4c00e7e8b3da30f10be0a2a";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"de0be4dddb67b4a52c5cda57a35aca2ee112ad11";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"0d541617b01a75f1e615f35f8202e1747384f5b5";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"fafd30cdb7e0c546217d8bd7aae493ad701f385c";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"f2ec6976856d2d06ab29684c982f8e41ac68de5d";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"766f7580c3df06c4369b4bcb82a630ec7d8a2a35";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}}

0 comments on commit 2904d7a

Please sign in to comment.