| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197 |
- <?php
- namespace Elasticsearch\Namespaces;
- /**
- * Class IndicesNamespace
- *
- * @category Elasticsearch
- * @package Elasticsearch\Namespaces\IndicesNamespace
- * @author Zachary Tong <zach@elastic.co>
- * @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
- * @link http://elastic.co
- */
- class IndicesNamespace extends AbstractNamespace
- {
- /**
- * $params['index'] = (list) A comma-separated list of indices to check (Required)
- *
- * @param $params array Associative array of parameters
- *
- * @return boolean
- */
- public function exists($params)
- {
- $index = $this->extractArgument($params, 'index');
- //manually make this verbose so we can check status code
- $params['client']['verbose'] = true;
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Exists $endpoint */
- $endpoint = $endpointBuilder('Indices\Exists');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
- }
- /**
- * $params['index'] = (list) A comma-separated list of indices to check (Required)
- * ['feature'] = (list) A comma-separated list of features to return
- * ['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.
- * ['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
- *
- * @param $params array Associative array of parameters
- *
- * @return bool
- */
- public function get($params)
- {
- $index = $this->extractArgument($params, 'index');
- $feature = $this->extractArgument($params, 'feature');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Get');
- $endpoint->setIndex($index)
- ->setFeature($feature)
- ->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- * ['operation_threading'] = () TODO: ?
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function segments($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Segments $endpoint */
- $endpoint = $endpointBuilder('Indices\Segments');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['name'] = (string) The name of the template (Required)
- * ['timeout'] = (time) Explicit operation timeout
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function deleteTemplate($params)
- {
- $name = $this->extractArgument($params, 'name');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Template\Delete $endpoint */
- $endpoint = $endpointBuilder('Indices\Template\Delete');
- $endpoint->setName($name);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of indices to delete; use `_all` or empty string to delete all indices
- * ['timeout'] = (time) Explicit operation timeout
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function delete($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Delete $endpoint */
- $endpoint = $endpointBuilder('Indices\Delete');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['fields'] = (boolean) A comma-separated list of fields for `fielddata` metric (supports wildcards)
- * ['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- * ['indexing_types'] = (list) A comma-separated list of document types to include in the `indexing` statistics
- * ['metric_family'] = (enum) Limit the information returned to a specific metric
- * ['search_groups'] = (list) A comma-separated list of search groups to include in the `search` statistics
- * ['all'] = (boolean) Return all available information
- * ['clear'] = (boolean) Reset the default level of detail
- * ['docs'] = (boolean) Return information about indexed and deleted documents
- * ['fielddata'] = (boolean) Return information about field data
- * ['filter_cache'] = (boolean) Return information about filter cache
- * ['flush'] = (boolean) Return information about flush operations
- * ['get'] = (boolean) Return information about get operations
- * ['groups'] = (boolean) A comma-separated list of search groups for `search` statistics
- * ['id_cache'] = (boolean) Return information about ID cache
- * ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
- * ['indexing'] = (boolean) Return information about indexing operations
- * ['merge'] = (boolean) Return information about merge operations
- * ['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
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function stats($params = array())
- {
- $metric = $this->extractArgument($params, 'metric');
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Stats $endpoint */
- $endpoint = $endpointBuilder('Indices\Stats');
- $endpoint->setIndex($index)
- ->setMetric($metric);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- * ['body'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function putSettings($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Settings\Put $endpoint */
- $endpoint = $endpointBuilder('Indices\Settings\Put');
- $endpoint->setIndex($index)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function snapshotIndex($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Gateway\Snapshot $endpoint */
- $endpoint = $endpointBuilder('Indices\Gateway\Snapshot');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $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
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function shrink($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $target = $this->extractArgument($params, 'target');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Shrink $endpoint */
- $endpoint = $endpointBuilder('Indices\Shrink');
- $endpoint->setIndex($index)
- ->setTarget($target)
- ->setBody($body);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['type'] = (list) A comma-separated list of document types
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getMapping($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $type = $this->extractArgument($params, 'type');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Mapping\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Mapping\Get');
- $endpoint->setIndex($index)
- ->setType($type);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['type'] = (list) A comma-separated list of document types
- * ['field'] = (list) A comma-separated list of document fields
- * ['include_defaults'] = (bool) specifies default mapping values should be returned
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getFieldMapping($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $type = $this->extractArgument($params, 'type');
- $fields = $this->extractArgument($params, 'fields');
- if (!isset($fields)) {
- $fields = $this->extractArgument($params, 'field');
- }
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Mapping\GetField $endpoint */
- $endpoint = $endpointBuilder('Indices\Mapping\GetField');
- $endpoint->setIndex($index)
- ->setType($type)
- ->setFields($fields);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['force'] = (boolean) TODO: ?
- * ['full'] = (boolean) TODO: ?
- * ['refresh'] = (boolean) Refresh the index after performing the operation
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function flush($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Flush $endpoint */
- $endpoint = $endpointBuilder('Indices\Flush');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['force'] = (boolean) TODO: ?
- * ['full'] = (boolean) TODO: ?
- * ['refresh'] = (boolean) Refresh the index after performing the operation
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function flushSynced($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Flush $endpoint */
- $endpoint = $endpointBuilder('Indices\Flush');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- $endpoint->setSynced(true);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- * ['operation_threading'] = () TODO: ?
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function refresh($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Refresh $endpoint */
- $endpoint = $endpointBuilder('Indices\Refresh');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['detailed'] = (bool) Whether to display detailed information about shard recovery
- * ['active_only'] = (bool) Display only those recoveries that are currently on-going
- * ['human'] = (bool) Whether to return time and byte values in human-readable format.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function recovery($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Flush $endpoint */
- $endpoint = $endpointBuilder('Indices\Recovery');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` to check the types across all indices (Required)
- * ['type'] = (list) A comma-separated list of document types to check (Required)
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return boolean
- */
- public function existsType($params)
- {
- $index = $this->extractArgument($params, 'index');
- $type = $this->extractArgument($params, 'type');
- //manually make this verbose so we can check status code
- $params['client']['verbose'] = true;
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Type\Exists $endpoint */
- $endpoint = $endpointBuilder('Indices\Type\Exists');
- $endpoint->setIndex($index)
- ->setType($type);
- $endpoint->setParams($params);
- return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
- }
- /**
- * $params['index'] = (string) The name of the index with an alias
- * ['name'] = (string) The name of the alias to be created or updated
- * ['timeout'] = (time) Explicit timestamp for the document
- * ['body'] = (time) Explicit timestamp for the document
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function putAlias($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $name = $this->extractArgument($params, 'name');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Alias\Put $endpoint */
- $endpoint = $endpointBuilder('Indices\Alias\Put');
- $endpoint->setIndex($index)
- ->setName($name)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['name'] = (string) The name of the template (Required)
- * ['order'] = (number) The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
- * ['timeout'] = (time) Explicit operation timeout
- * ['body'] = (time) Explicit operation timeout
- * ['create'] = (bool) Whether the index template should only be added if new or can also replace an existing one
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function putTemplate($params)
- {
- $name = $this->extractArgument($params, 'name');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Template\Put $endpoint */
- $endpoint = $endpointBuilder('Indices\Template\Put');
- $endpoint->setName($name)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $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
- * ['type'] = (list) A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
- * ['explain'] = (boolean) Return detailed information about the error
- * ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
- * ['operation_threading'] = () TODO: ?
- * ['source'] = (string) The URL-encoded query definition (instead of using the request body)
- * ['body'] = (string) The URL-encoded query definition (instead of using the request body)
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function validateQuery($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $type = $this->extractArgument($params, 'type');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Validate\Query $endpoint */
- $endpoint = $endpointBuilder('Indices\Validate\Query');
- $endpoint->setIndex($index)
- ->setType($type)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['name'] = (list) A comma-separated list of alias names to return (Required)
- * ['index'] = (list) A comma-separated list of index names to filter aliases
- * ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
- * ['name'] = (list) A comma-separated list of alias names to return
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getAlias($params)
- {
- $index = $this->extractArgument($params, 'index');
- $name = $this->extractArgument($params, 'name');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Alias\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Alias\Get');
- $endpoint->setIndex($index)
- ->setName($name);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` to perform the operation on all indices (Required)
- * ['type'] = (string) The name of the document type
- * ['ignore_conflicts'] = (boolean) Specify whether to ignore conflicts while updating the mapping (default: false)
- * ['timeout'] = (time) Explicit operation timeout
- * ['body'] = (time) Explicit operation timeout
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function putMapping($params)
- {
- $index = $this->extractArgument($params, 'index');
- $type = $this->extractArgument($params, 'type');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Mapping\Put $endpoint */
- $endpoint = $endpointBuilder('Indices\Mapping\Put');
- $endpoint->setIndex($index)
- ->setType($type)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` for all indices (Required)
- * ['type'] = (string) The name of the document type to delete (Required)
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function deleteMapping($params)
- {
- $index = $this->extractArgument($params, 'index');
- $type = $this->extractArgument($params, 'type');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Mapping\Delete $endpoint */
- $endpoint = $endpointBuilder('Indices\Mapping\Delete');
- $endpoint->setIndex($index)
- ->setType($type);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['name'] = (string) The name of the template (Required)
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getTemplate($params)
- {
- $name = $this->extractArgument($params, 'name');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Template\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Template\Get');
- $endpoint->setName($name);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['name'] = (string) The name of the template (Required)
- *
- * @param $params array Associative array of parameters
- *
- * @return boolean
- */
- public function existsTemplate($params)
- {
- $name = $this->extractArgument($params, 'name');
- //manually make this verbose so we can check status code
- $params['client']['verbose'] = true;
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Template\Exists $endpoint */
- $endpoint = $endpointBuilder('Indices\Template\Exists');
- $endpoint->setName($name);
- $endpoint->setParams($params);
- return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
- }
- /**
- * $params['index'] = (string) The name of the index (Required)
- * ['timeout'] = (time) Explicit operation timeout
- * ['body'] = (time) Explicit operation timeout
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function create($params)
- {
- $index = $this->extractArgument($params, 'index');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Create $endpoint */
- $endpoint = $endpointBuilder('Indices\Create');
- $endpoint->setIndex($index)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function forceMerge($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\ForceMerge $endpoint */
- $endpoint = $endpointBuilder('Indices\ForceMerge');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (string) The name of the index with an alias (Required)
- * ['name'] = (string) The name of the alias to be deleted (Required)
- * ['timeout'] = (time) Explicit timestamp for the document
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function deleteAlias($params)
- {
- $index = $this->extractArgument($params, 'index');
- $name = $this->extractArgument($params, 'name');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Alias\Delete $endpoint */
- $endpoint = $endpointBuilder('Indices\Alias\Delete');
- $endpoint->setIndex($index)
- ->setName($name);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (string) The name of the index (Required)
- * ['timeout'] = (time) Explicit operation timeout
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function open($params)
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Open $endpoint */
- $endpoint = $endpointBuilder('Indices\Open');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $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)
- * ['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"])
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function analyze($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Analyze $endpoint */
- $endpoint = $endpointBuilder('Indices\Analyze');
- $endpoint->setIndex($index)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index name to limit the operation
- * ['field_data'] = (boolean) Clear field data
- * ['fielddata'] = (boolean) Clear field data
- * ['fields'] = (list) A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
- * ['filter'] = (boolean) Clear filter caches
- * ['filter_cache'] = (boolean) Clear filter caches
- * ['filter_keys'] = (boolean) A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)
- * ['id'] = (boolean) Clear ID caches for parent/child
- * ['id_cache'] = (boolean) Clear ID caches for parent/child
- * ['recycler'] = (boolean) Clear the recycler cache
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function clearCache($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Cache\Clear $endpoint */
- $endpoint = $endpointBuilder('Indices\Cache\Clear');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names to filter aliases
- * ['timeout'] = (time) Explicit timestamp for the document
- * ['body'] = (time) Explicit timestamp for the document
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function updateAliases($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Aliases\Update $endpoint */
- $endpoint = $endpointBuilder('Indices\Aliases\Update');
- $endpoint->setIndex($index)
- ->setBody($body);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['local'] = (bool) Return local information, do not retrieve the state from master node (default: false)
- * ['timeout'] = (time) Explicit timestamp for the document
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getAliases($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $name = $this->extractArgument($params, 'name');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Alias\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Alias\Get');
- $endpoint->setIndex($index)
- ->setName($name);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['name'] = (list) A comma-separated list of alias names to return (Required)
- * ['index'] = (list) A comma-separated list of index names to filter aliases
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return boolean
- */
- public function existsAlias($params)
- {
- $index = $this->extractArgument($params, 'index');
- $name = $this->extractArgument($params, 'name');
- //manually make this verbose so we can check status code
- $params['client']['verbose'] = true;
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Alias\Exists $endpoint */
- $endpoint = $endpointBuilder('Indices\Alias\Exists');
- $endpoint->setIndex($index)
- ->setName($name);
- $endpoint->setParams($params);
- return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- * ['ignore_indices'] = (enum) When performed on multiple indices, allows to ignore `missing` ones
- * ['operation_threading'] = () TODO: ?
- * ['recovery'] = (boolean) Return information about shard recovery
- * ['snapshot'] = (boolean) TODO: ?
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function status($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Status $endpoint */
- $endpoint = $endpointBuilder('Indices\Status');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getSettings($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $name = $this->extractArgument($params, 'name');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Settings\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Settings\Get');
- $endpoint->setIndex($index)
- ->setName($name);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (string) The name of the index (Required)
- * ['timeout'] = (time) Explicit operation timeout
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function close($params)
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Close $endpoint */
- $endpoint = $endpointBuilder('Indices\Close');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (string) The name of the index
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function seal($params)
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Seal $endpoint */
- $endpoint = $endpointBuilder('Indices\Seal');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['wait_for_completion']= (boolean) Specify whether the request should block until the all segments are upgraded (default: false)
- * ['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will be upgraded
- * ['refresh'] = (boolean) Refresh the index after performing the operation
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function upgrade($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Upgrade\Post $endpoint */
- $endpoint = $endpointBuilder('Indices\Upgrade\Post');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string for all indices
- * ['wait_for_completion']= (boolean) Specify whether the request should block until the all segments are upgraded (default: false)
- * ['only_ancient_segments'] = (boolean) If true, only ancient (an older Lucene major release) segments will be upgraded
- * ['refresh'] = (boolean) Refresh the index after performing the operation
- * ['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.
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function getUpgrade($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Upgrade\Get $endpoint */
- $endpoint = $endpointBuilder('Indices\Upgrade\Get');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (string) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
- * ['status'] = (list) A comma-separated list of statuses used to filter on shards to get store information for
- * ['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
- * ['allow_no_indices'] = (boolean) 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'] = (boolean) Whether to expand wildcard expression to concrete indices that are open, closed or both.
- * ['operation_threading']
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function shardStores($params)
- {
- $index = $this->extractArgument($params, 'index');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\ShardStores $endpoint */
- $endpoint = $endpointBuilder('Indices\ShardStores');
- $endpoint->setIndex($index);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['newIndex'] = (string) The name of the rollover index
- * ['alias'] = (string) The name of the alias to rollover
- * ['timeout'] = (time) Explicit operation timeout
- * ['master_timeout'] = (time) Specify timeout for connection to master
- *
- * @param $params array Associative array of parameters
- *
- * @return array
- */
- public function rollover($params)
- {
- $newIndex = $this->extractArgument($params, 'newIndex');
- $alias = $this->extractArgument($params, 'alias');
- $body = $this->extractArgument($params, 'body');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Rollover $endpoint */
- $endpoint = $endpointBuilder('Indices\Rollover');
- $endpoint->setNewIndex($newIndex)
- ->setAlias($alias)
- ->setParams($params)
- ->setBody($body);
- return $this->performRequest($endpoint);
- }
- /**
- * $params['index'] = (string) The name of the source index to split
- * ['target'] = (string) The name of the target index to split into
- * ['copy_settings'] = (boolean) whether or not to copy settings from the source index (defaults to false)
- * ['timeout'] = (time) Explicit operation timeout
- * ['master_timeout'] = (time) Specify timeout for connection to master
- * ['wait_for_active_shards'] = (string) Set the number of active shards to wait for on the shrunken index before the operation returns.
- *
- * @param array $params Associative array of parameters
- *
- * @return array
- * @throws \Exception
- */
- public function split($params = array())
- {
- $index = $this->extractArgument($params, 'index');
- $body = $this->extractArgument($params, 'body');
- $target = $this->extractArgument($params, 'target');
- /** @var callback $endpointBuilder */
- $endpointBuilder = $this->endpoints;
- /** @var \Elasticsearch\Endpoints\Indices\Split $endpoint */
- $endpoint = $endpointBuilder('Indices\Split');
- $endpoint->setIndex($index)
- ->setBody($body)
- ->setTarget($target);
- $endpoint->setParams($params);
- return $this->performRequest($endpoint);
- }
- }
|