Skip to content

Commit 030d96e

Browse files
polyfractalpolyfractal
committed
[DOCS] Regenerate reference docs
1 parent d56e2c4 commit 030d96e

File tree

3 files changed

+26
-162
lines changed

3 files changed

+26
-162
lines changed

‎docs/build/Elasticsearch/Client.asciidoc

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ The class defines the following methods:
3636
* <<Elasticsearch_Clientsuggest_suggest,`suggest()`>>
3737
* <<Elasticsearch_Clientexplain_explain,`explain()`>>
3838
* <<Elasticsearch_Clientsearch_search,`search()`>>
39-
* <<Elasticsearch_ClientsearchExists_searchExists,`searchExists()`>>
4039
* <<Elasticsearch_ClientsearchShards_searchShards,`searchShards()`>>
4140
* <<Elasticsearch_ClientsearchTemplate_searchTemplate,`searchTemplate()`>>
4241
* <<Elasticsearch_Clientscroll_scroll,`scroll()`>>
@@ -538,7 +537,6 @@ $params['index'] = (string) The name of the index (Required)
538537
['id'] = (string) Specific document ID (when the POST method is used)
539538
['consistency'] = (enum) Explicit write consistency setting for the operation
540539
['parent'] = (string) ID of the parent document
541-
['percolate'] = (string) Percolator queries to execute while indexing the document
542540
['refresh'] = (boolean) Refresh the index after performing the operation
543541
['replication'] = (enum) Specific replication type
544542
['routing'] = (string) Specific routing value
@@ -601,7 +599,6 @@ $params['index'] = (string) The name of the index (Required)
601599
['consistency'] = (enum) Explicit write consistency setting for the operation
602600
['op_type'] = (enum) Explicit operation type
603601
['parent'] = (string) ID of the parent document
604-
['percolate'] = (string) Percolator queries to execute while indexing the document
605602
['refresh'] = (boolean) Refresh the index after performing the operation
606603
['replication'] = (enum) Specific replication type
607604
['routing'] = (string) Specific routing value
@@ -770,58 +767,6 @@ $response = $client->search($params);
770767

771768

772769

773-
[[Elasticsearch_ClientsearchExists_searchExists]]
774-
.`searchExists()`
775-
****
776-
[source,php]
777-
----
778-
/*
779-
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
780-
['type'] = (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
781-
['analyzer'] = (string) The analyzer to use for the query string
782-
['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
783-
['default_operator'] = (enum) The default operator for query string query (AND or OR)
784-
['df'] = (string) The field to use as default where no field prefix is given in the query string
785-
['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit
786-
['fields'] = (list) A comma-separated list of fields to return as part of a hit
787-
['from'] = (number) Starting offset (default: 0)
788-
['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
789-
['indices_boost'] = (list) Comma-separated list of index boosts
790-
['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
791-
['lowercase_expanded_terms'] = (boolean) Specify whether query terms should be lowercased
792-
['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
793-
['q'] = (string) Query in the Lucene query string syntax
794-
['routing'] = (list) A comma-separated list of specific routing values
795-
['scroll'] = (duration) Specify how long a consistent view of the index should be maintained for scrolled search
796-
['search_type'] = (enum) Search operation type
797-
['size'] = (number) Number of hits to return (default: 10)
798-
['sort'] = (list) A comma-separated list of <field>:<direction> pairs
799-
['source'] = (string) The URL-encoded request definition using the Query DSL (instead of using request body)
800-
['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
801-
['_source_exclude'] = (list) A list of fields to exclude from the returned _source field
802-
['_source_include'] = (list) A list of fields to extract and return from the _source field
803-
['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
804-
['suggest_field'] = (string) Specify which field to use for suggestions
805-
['suggest_mode'] = (enum) Specify suggest mode
806-
['suggest_size'] = (number) How many suggestions to return in response
807-
['suggest_text'] = (text) The source text for which the suggestions should be returned
808-
['timeout'] = (time) Explicit operation timeout
809-
['version'] = (boolean) Specify whether to return document version as part of a hit
810-
['body'] = (array|string) The search definition using the Query DSL
811-
['body'] = (array) Request body
812-
*/
813-
814-
$params = [
815-
// ...
816-
];
817-
818-
$client = ClientBuilder::create()->build();
819-
$response = $client->searchExists($params);
820-
----
821-
****
822-
823-
824-
825770
[[Elasticsearch_ClientsearchShards_searchShards]]
826771
.`searchShards()`
827772
****
@@ -931,7 +876,6 @@ $params['id'] = (string) Document ID (Required)
931876
['fields'] = (list) A comma-separated list of fields to return in the response
932877
['lang'] = (string) The script language (default: mvel)
933878
['parent'] = (string) ID of the parent document
934-
['percolate'] = (string) Perform percolation during the operation; use specific registered query name, attribute, or wildcard
935879
['refresh'] = (boolean) Refresh the index after performing the operation
936880
['replication'] = (enum) Specific replication type
937881
['retry_on_conflict'] = (number) Specify how many times should the operation be retried when a conflict occurs (default: 0)

‎docs/build/Elasticsearch/Namespaces/IndicesNamespace.asciidoc

Lines changed: 25 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ The class defines the following methods:
1616
* <<Elasticsearch_Namespaces_IndicesNamespaceget_get,`get()`>>
1717
* <<Elasticsearch_Namespaces_IndicesNamespacesegments_segments,`segments()`>>
1818
* <<Elasticsearch_Namespaces_IndicesNamespacedeleteTemplate_deleteTemplate,`deleteTemplate()`>>
19-
* <<Elasticsearch_Namespaces_IndicesNamespacedeleteWarmer_deleteWarmer,`deleteWarmer()`>>
2019
* <<Elasticsearch_Namespaces_IndicesNamespacedelete_delete,`delete()`>>
2120
* <<Elasticsearch_Namespaces_IndicesNamespacestats_stats,`stats()`>>
2221
* <<Elasticsearch_Namespaces_IndicesNamespaceputSettings_putSettings,`putSettings()`>>
2322
* <<Elasticsearch_Namespaces_IndicesNamespacesnapshotIndex_snapshotIndex,`snapshotIndex()`>>
23+
* <<Elasticsearch_Namespaces_IndicesNamespaceshrink_shrink,`shrink()`>>
2424
* <<Elasticsearch_Namespaces_IndicesNamespacegetMapping_getMapping,`getMapping()`>>
2525
* <<Elasticsearch_Namespaces_IndicesNamespacegetFieldMapping_getFieldMapping,`getFieldMapping()`>>
2626
* <<Elasticsearch_Namespaces_IndicesNamespaceflush_flush,`flush()`>>
@@ -29,8 +29,6 @@ The class defines the following methods:
2929
* <<Elasticsearch_Namespaces_IndicesNamespacerecovery_recovery,`recovery()`>>
3030
* <<Elasticsearch_Namespaces_IndicesNamespaceexistsType_existsType,`existsType()`>>
3131
* <<Elasticsearch_Namespaces_IndicesNamespaceputAlias_putAlias,`putAlias()`>>
32-
* <<Elasticsearch_Namespaces_IndicesNamespacegetWarmer_getWarmer,`getWarmer()`>>
33-
* <<Elasticsearch_Namespaces_IndicesNamespaceputWarmer_putWarmer,`putWarmer()`>>
3432
* <<Elasticsearch_Namespaces_IndicesNamespaceputTemplate_putTemplate,`putTemplate()`>>
3533
* <<Elasticsearch_Namespaces_IndicesNamespacevalidateQuery_validateQuery,`validateQuery()`>>
3634
* <<Elasticsearch_Namespaces_IndicesNamespacegetAlias_getAlias,`getAlias()`>>
@@ -39,7 +37,6 @@ The class defines the following methods:
3937
* <<Elasticsearch_Namespaces_IndicesNamespacegetTemplate_getTemplate,`getTemplate()`>>
4038
* <<Elasticsearch_Namespaces_IndicesNamespaceexistsTemplate_existsTemplate,`existsTemplate()`>>
4139
* <<Elasticsearch_Namespaces_IndicesNamespacecreate_create,`create()`>>
42-
* <<Elasticsearch_Namespaces_IndicesNamespaceoptimize_optimize,`optimize()`>>
4340
* <<Elasticsearch_Namespaces_IndicesNamespaceforceMerge_forceMerge,`forceMerge()`>>
4441
* <<Elasticsearch_Namespaces_IndicesNamespacedeleteAlias_deleteAlias,`deleteAlias()`>>
4542
* <<Elasticsearch_Namespaces_IndicesNamespaceopen_open,`open()`>>
@@ -151,29 +148,6 @@ $response = $client->indices()->deleteTemplate($params);
151148

152149

153150

154-
[[Elasticsearch_Namespaces_IndicesNamespacedeleteWarmer_deleteWarmer]]
155-
.`deleteWarmer()`
156-
****
157-
[source,php]
158-
----
159-
/*
160-
$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)
161-
['name'] = (string) The name of the warmer (supports wildcards); leave empty to delete all warmers
162-
['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
163-
['body'] = (array) Request body
164-
*/
165-
166-
$params = [
167-
// ...
168-
];
169-
170-
$client = ClientBuilder::create()->build();
171-
$response = $client->indices()->deleteWarmer($params);
172-
----
173-
****
174-
175-
176-
177151
[[Elasticsearch_Namespaces_IndicesNamespacedelete_delete]]
178152
.`delete()`
179153
****
@@ -222,7 +196,6 @@ $params['fields'] = (boolean) A comma-separated list of fields for `fiel
222196
['refresh'] = (boolean) Return information about refresh operations
223197
['search'] = (boolean) Return information about search operations; use the `groups` parameter to include information for specific search groups
224198
['store'] = (boolean) Return information about the size of the index
225-
['warmer'] = (boolean) Return information about warmers
226199
['body'] = (array) Request body
227200
*/
228201
@@ -283,6 +256,30 @@ $response = $client->indices()->snapshotIndex($params);
283256

284257

285258

259+
[[Elasticsearch_Namespaces_IndicesNamespaceshrink_shrink]]
260+
.`shrink()`
261+
****
262+
[source,php]
263+
----
264+
/*
265+
$params['index'] = (string) The name of the source index to shrink
266+
['target'] = (string) The name of the target index to shrink into
267+
['timeout'] = (time) Explicit operation timeout
268+
['master_timeout'] = (time) Specify timeout for connection to master
269+
['body'] = (array) Request body
270+
*/
271+
272+
$params = [
273+
// ...
274+
];
275+
276+
$client = ClientBuilder::create()->build();
277+
$response = $client->indices()->shrink($params);
278+
----
279+
****
280+
281+
282+
286283
[[Elasticsearch_Namespaces_IndicesNamespacegetMapping_getMapping]]
287284
.`getMapping()`
288285
****
@@ -481,53 +478,6 @@ $response = $client->indices()->putAlias($params);
481478

482479

483480

484-
[[Elasticsearch_Namespaces_IndicesNamespacegetWarmer_getWarmer]]
485-
.`getWarmer()`
486-
****
487-
[source,php]
488-
----
489-
/*
490-
$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)
491-
['name'] = (string) The name of the warmer (supports wildcards); leave empty to get all warmers
492-
['type'] = (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
493-
['body'] = (array) Request body
494-
*/
495-
496-
$params = [
497-
// ...
498-
];
499-
500-
$client = ClientBuilder::create()->build();
501-
$response = $client->indices()->getWarmer($params);
502-
----
503-
****
504-
505-
506-
507-
[[Elasticsearch_Namespaces_IndicesNamespaceputWarmer_putWarmer]]
508-
.`putWarmer()`
509-
****
510-
[source,php]
511-
----
512-
/*
513-
$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)
514-
['name'] = (string) The name of the warmer (Required)
515-
['type'] = (list) A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
516-
['body'] = (list) A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types
517-
['body'] = (array) Request body
518-
*/
519-
520-
$params = [
521-
// ...
522-
];
523-
524-
$client = ClientBuilder::create()->build();
525-
$response = $client->indices()->putWarmer($params);
526-
----
527-
****
528-
529-
530-
531481
[[Elasticsearch_Namespaces_IndicesNamespaceputTemplate_putTemplate]]
532482
.`putTemplate()`
533483
****
@@ -716,36 +666,6 @@ $response = $client->indices()->create($params);
716666

717667

718668

719-
[[Elasticsearch_Namespaces_IndicesNamespaceoptimize_optimize]]
720-
.`optimize()`
721-
****
722-
[source,php]
723-
----
724-
/*
725-
$params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
726-
['flush'] = (boolean) Specify whether the index should be flushed after performing the operation (default: true)
727-
['max_num_segments'] = (number) The number of segments the index should be merged into (default: dynamic)
728-
['only_expunge_deletes'] = (boolean) Specify whether the operation should only expunge deleted documents
729-
['operation_threading'] = () TODO: ?
730-
['refresh'] = (boolean) Specify whether the index should be refreshed after performing the operation (default: true)
731-
['wait_for_merge'] = (boolean) Specify whether the request should block until the merge process is finished (default: true)
732-
['ignore_unavailable'] = (bool) Whether specified concrete indices should be ignored when unavailable (missing or closed)
733-
['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)
734-
['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both.
735-
['body'] = (array) Request body
736-
*/
737-
738-
$params = [
739-
// ...
740-
];
741-
742-
$client = ClientBuilder::create()->build();
743-
$response = $client->indices()->optimize($params);
744-
----
745-
****
746-
747-
748-
749669
[[Elasticsearch_Namespaces_IndicesNamespaceforceMerge_forceMerge]]
750670
.`forceMerge()`
751671
****

‎docs/build/renderer.index

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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";}}}
1+
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 commit comments

Comments
 (0)