Skip to content

Commit

Permalink
[DOCS] Regenerate reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@polyfractal
polyfractal committed May 31, 2016
1 parent d56e2c4 commit 030d96e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 162 deletions.
56 changes: 0 additions & 56 deletions docs/build/Elasticsearch/Client.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ The class defines the following methods:
* <<Elasticsearch_Clientsuggest_suggest,`suggest()`>>
* <<Elasticsearch_Clientexplain_explain,`explain()`>>
* <<Elasticsearch_Clientsearch_search,`search()`>>
* <<Elasticsearch_ClientsearchExists_searchExists,`searchExists()`>>
* <<Elasticsearch_ClientsearchShards_searchShards,`searchShards()`>>
* <<Elasticsearch_ClientsearchTemplate_searchTemplate,`searchTemplate()`>>
* <<Elasticsearch_Clientscroll_scroll,`scroll()`>>
Expand Down Expand Up @@ -538,7 +537,6 @@ $params['index'] = (string) The name of the index (Required)
['id'] = (string) Specific document ID (when the POST method is used)
['consistency'] = (enum) Explicit write consistency setting for the operation
['parent'] = (string) ID of the parent document
['percolate'] = (string) Percolator queries to execute while indexing the document
['refresh'] = (boolean) Refresh the index after performing the operation
['replication'] = (enum) Specific replication type
['routing'] = (string) Specific routing value
Expand Down Expand Up @@ -601,7 +599,6 @@ $params['index'] = (string) The name of the index (Required)
['consistency'] = (enum) Explicit write consistency setting for the operation
['op_type'] = (enum) Explicit operation type
['parent'] = (string) ID of the parent document
['percolate'] = (string) Percolator queries to execute while indexing the document
['refresh'] = (boolean) Refresh the index after performing the operation
['replication'] = (enum) Specific replication type
['routing'] = (string) Specific routing value
Expand Down Expand Up @@ -770,58 +767,6 @@ $response = $client->search($params);



[[Elasticsearch_ClientsearchExists_searchExists]]
.`searchExists()`
****
[source,php]
----
/*
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
['type'] = (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
['analyzer'] = (string) The analyzer to use for the query string
['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
['default_operator'] = (enum) The default operator for query string query (AND or OR)
['df'] = (string) The field to use as default where no field prefix is given in the query string
['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit
['fields'] = (list) A comma-separated list of fields to return as part of a hit
['from'] = (number) Starting offset (default: 0)
['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
['indices_boost'] = (list) Comma-separated list of index boosts
['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
['lowercase_expanded_terms'] = (boolean) Specify whether query terms should be lowercased
['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
['q'] = (string) Query in the Lucene query string syntax
['routing'] = (list) A comma-separated list of specific routing values
['scroll'] = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
['search_type'] = (enum) Search operation type
['size'] = (number) Number of hits to return (default: 10)
['sort'] = (list) A comma-separated list of <field>:<direction> pairs
['source'] = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
['_source_include'] = (list) A list of fields to extract and return from the _source field
['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
['suggest_field'] = (string) Specify which field to use for suggestions
['suggest_mode'] = (enum) Specify suggest mode
['suggest_size'] = (number) How many suggestions to return in response
['suggest_text'] = (text) The source text for which the suggestions should be returned
['timeout'] = (time) Explicit operation timeout
['version'] = (boolean) Specify whether to return document version as part of a hit
['body'] = (array|string) The search definition using the Query DSL
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->searchExists($params);
----
****



[[Elasticsearch_ClientsearchShards_searchShards]]
.`searchShards()`
****
Expand Down Expand Up @@ -931,7 +876,6 @@ $params['id'] = (string) Document ID (Required)
['fields'] = (list) A comma-separated list of fields to return in the response
['lang'] = (string) The script language (default: mvel)
['parent'] = (string) ID of the parent document
['percolate'] = (string) Perform percolation during the operation; use specific registered query name, attribute, or wildcard
['refresh'] = (boolean) Refresh the index after performing the operation
['replication'] = (enum) Specific replication type
['retry_on_conflict'] = (number) Specify how many times should the operation be retried when a conflict occurs (default: 0)
Expand Down
130 changes: 25 additions & 105 deletions docs/build/Elasticsearch/Namespaces/IndicesNamespace.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ The class defines the following methods:
* <<Elasticsearch_Namespaces_IndicesNamespaceget_get,`get()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacesegments_segments,`segments()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacedeleteTemplate_deleteTemplate,`deleteTemplate()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacedeleteWarmer_deleteWarmer,`deleteWarmer()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacedelete_delete,`delete()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacestats_stats,`stats()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceputSettings_putSettings,`putSettings()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacesnapshotIndex_snapshotIndex,`snapshotIndex()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceshrink_shrink,`shrink()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacegetMapping_getMapping,`getMapping()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacegetFieldMapping_getFieldMapping,`getFieldMapping()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceflush_flush,`flush()`>>
Expand All @@ -29,8 +29,6 @@ The class defines the following methods:
* <<Elasticsearch_Namespaces_IndicesNamespacerecovery_recovery,`recovery()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceexistsType_existsType,`existsType()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceputAlias_putAlias,`putAlias()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacegetWarmer_getWarmer,`getWarmer()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceputWarmer_putWarmer,`putWarmer()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceputTemplate_putTemplate,`putTemplate()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacevalidateQuery_validateQuery,`validateQuery()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacegetAlias_getAlias,`getAlias()`>>
Expand All @@ -39,7 +37,6 @@ The class defines the following methods:
* <<Elasticsearch_Namespaces_IndicesNamespacegetTemplate_getTemplate,`getTemplate()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceexistsTemplate_existsTemplate,`existsTemplate()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacecreate_create,`create()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceoptimize_optimize,`optimize()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceforceMerge_forceMerge,`forceMerge()`>>
* <<Elasticsearch_Namespaces_IndicesNamespacedeleteAlias_deleteAlias,`deleteAlias()`>>
* <<Elasticsearch_Namespaces_IndicesNamespaceopen_open,`open()`>>
Expand Down Expand Up @@ -151,29 +148,6 @@ $response = $client->indices()->deleteTemplate($params);



[[Elasticsearch_Namespaces_IndicesNamespacedeleteWarmer_deleteWarmer]]
.`deleteWarmer()`
****
[source,php]
----
/*
$params['index'] = (list) A comma-separated list of index names to register warmer for; use `_all` or empty string to perform the operation on all indices (Required)
['name'] = (string) The name of the warmer (supports wildcards); leave empty to delete all warmers
['type'] = (list) A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->deleteWarmer($params);
----
****



[[Elasticsearch_Namespaces_IndicesNamespacedelete_delete]]
.`delete()`
****
Expand Down Expand Up @@ -222,7 +196,6 @@ $params['fields'] = (boolean) A comma-separated list of fields for `fiel
['refresh'] = (boolean) Return information about refresh operations
['search'] = (boolean) Return information about search operations; use the `groups` parameter to include information for specific search groups
['store'] = (boolean) Return information about the size of the index
['warmer'] = (boolean) Return information about warmers
['body'] = (array) Request body
*/
Expand Down Expand Up @@ -283,6 +256,30 @@ $response = $client->indices()->snapshotIndex($params);



[[Elasticsearch_Namespaces_IndicesNamespaceshrink_shrink]]
.`shrink()`
****
[source,php]
----
/*
$params['index'] = (string) The name of the source index to shrink
['target'] = (string) The name of the target index to shrink into
['timeout'] = (time) Explicit operation timeout
['master_timeout'] = (time) Specify timeout for connection to master
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->shrink($params);
----
****



[[Elasticsearch_Namespaces_IndicesNamespacegetMapping_getMapping]]
.`getMapping()`
****
Expand Down Expand Up @@ -481,53 +478,6 @@ $response = $client->indices()->putAlias($params);



[[Elasticsearch_Namespaces_IndicesNamespacegetWarmer_getWarmer]]
.`getWarmer()`
****
[source,php]
----
/*
$params['index'] = (list) A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices (Required)
['name'] = (string) The name of the warmer (supports wildcards); leave empty to get all warmers
['type'] = (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->getWarmer($params);
----
****



[[Elasticsearch_Namespaces_IndicesNamespaceputWarmer_putWarmer]]
.`putWarmer()`
****
[source,php]
----
/*
$params['index'] = (list) A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices (Required)
['name'] = (string) The name of the warmer (Required)
['type'] = (list) A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
['body'] = (list) A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->putWarmer($params);
----
****



[[Elasticsearch_Namespaces_IndicesNamespaceputTemplate_putTemplate]]
.`putTemplate()`
****
Expand Down Expand Up @@ -716,36 +666,6 @@ $response = $client->indices()->create($params);



[[Elasticsearch_Namespaces_IndicesNamespaceoptimize_optimize]]
.`optimize()`
****
[source,php]
----
/*
$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
['flush'] = (boolean) Specify whether the index should be flushed after performing the operation (default: true)
['max_num_segments'] = (number) The number of segments the index should be merged into (default: dynamic)
['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
['operation_threading'] = () TODO: ?
['refresh'] = (boolean) Specify whether the index should be refreshed after performing the operation (default: true)
['wait_for_merge'] = (boolean) Specify whether the request should block until the merge process is finished (default: true)
['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
['allow_no_indices'] = (bool) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
['body'] = (array) Request body
*/
$params = [
// ...
];
$client = ClientBuilder::create()->build();
$response = $client->indices()->optimize($params);
----
****



[[Elasticsearch_Namespaces_IndicesNamespaceforceMerge_forceMerge]]
.`forceMerge()`
****
Expand Down
2 changes: 1 addition & 1 deletion docs/build/renderer.index
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
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";}}}
C:19:"Sami\Renderer\Index":944:{a:3:{i:0;a:9:{s:20:"Elasticsearch\Client";s:40:"8589a6368ef8292e7729d4022e7860c35bc917f5";s:27:"Elasticsearch\ClientBuilder";s:40:"5f2cf2187dd8605c6dbe984322a7c1b28efd4b98";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"8a81d20415e9a0bdfbc8fa67ff731494852b12cb";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"33ecc485564dfe01a4f80bb598d1fdb93618e3a8";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"2001306e5d927220507900797816d0f26552ecb9";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"b878049b4dde7abb3ee01c064b7c2386d5c35df4";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"45a880724016b0b33efa8857d264c96dfa0d4984";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"5ab2f7b8f6d7eaf13755089272762bba489b6595";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"00152d13de02f07981fa5cfb80e3e4f033b133dc";}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 030d96e

Please sign in to comment.