ldoc

• Index

Contents

• Methods

Classes

• Cat
• Client
• Cluster
• Indices
• Nodes
• Snapshot
• Tasks

Modules

• elasticsearch
• helper

Class Indices

The Indices class

Info:

• Author: Dhaval Kapil

Methods

Indices:deleteAlias (params)	Delete Alias function
Indices:existsAlias (params)	Exists Alias function
Indices:getAlias (params)	Get Alias function
Indices:putAlias (params)	Put Alias function
Indices:getAliases (params)	Get Aliases function
Indices:updateAliases (params)	Update Aliases function
Indices:clearCache (params)	Clear Cache function
Indices:deleteMapping (params)	Delete Mapping function
Indices:getMapping (params)	Get Mapping function
Indices:getFieldMapping (params)	Get Feild Mapping function
Indices:putMapping (params)	Put Mapping function
Indices:getSettings (params)	Get Settings function
Indices:putSettings (params)	Put Settings function
Indices:deleteTemplate (params)	Delete Template function
Indices:existsTemplate (params)	Exists Template function
Indices:getTemplate (params)	Get Template function
Indices:putTemplate (params)	Put Template function
Indices:existsType (params)	Exists Type function
Indices:getUpgrade (params)	Get Upgrade function
Indices:upgrade (params)	Upgrade function
Indices:validateQuery (params)	Validate Query function
Indices:deleteWarmer (params)	Delete Warmer function
Indices:getWarmer (params)	Get Warmer function
Indices:putWarmer (params)	Put Warmer function
Indices:exists (params)	Function to check whether an index exists or not
Indices:get (params)	Function to get an index
Indices:delete (params)	Function to delete indices
Indices:create (params)	Function to create an index
Indices:optimize (params)	Function to optimize an index
Indices:open (params)	Function to open an index
Indices:close (params)	Function to close an index
Indices:analyze (params)	Function to perform analysis process on a text
Indices:refresh (params)	Function to refresh an index
Indices:status (params)	Function to get the status of an index
Indices:seal (params)	Function to seal an index
Indices:flush (params)	Flush function
Indices:forceMerge (params)	Force Merge function
Indices:recovery (params)	Recovery function
Indices:segments (params)	Segments function
Indices:shardStores (params)	Shard Stores function
Indices:stats (params)	Stats function

Methods

Indices:deleteAlias (params)

Delete Alias function

Parameters:

• params

  The delete alias Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]          = (list) A comma-separated list of index names (supports wildcards); use '_all' for
       all indices (Required)
       ["name"]           = (list) A comma-separated list of aliases to delete (supports wildcards); use '_all'
       to delete all aliases for the specified indices. (Required)
       ["timeout"]        = (time) Explicit timestamp for the document
       ["master_timeout"] = (time) Specify timeout for connection to master

Indices:existsAlias (params)

Exists Alias function

Parameters:

• params

  The exists alias Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names to filter aliases
       ["name"]               = (list) A comma-separated list of alias names to return
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       [open,closed])
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:getAlias (params)

Get Alias function

Parameters:

• params

  The get alias Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names to filter aliases
       ["name"]               = (list) A comma-separated list of alias names to return
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       [open,closed])
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:putAlias (params)

Put Alias function

Parameters:

• params

  The put alias Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]          = (list) A comma-separated list of index names the alias should point to (supports
       wildcards); use '_all' to perform the operation on all indices. (Required)
       ["name"]           = (string) The name of the alias to be created or updated (Required)
       ["timeout"]        = (time) Explicit timestamp for the document
       ["master_timeout"] = (time) Specify timeout for connection to master
       ["body"]           = The settings for the alias, such as 'routing' or 'filter'

Indices:getAliases (params)

Get Aliases function

Parameters:

• params

  The get aliases Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]   = (list) A comma-separated list of index names to filter aliases
       ["name"]    = (list) A comma-separated list of alias names to filter
       ["timeout"] = (time) Explicit operation timeout
       ["local"]   = (boolean) Return local information, do not retrieve the state from master node (default:
       false)

Indices:updateAliases (params)

Update Aliases function

Parameters:

• params

  The update aliases Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["timeout"]        = (time) Request timeout
       ["master_timeout"] = (time) Specify timeout for connection to master
       ["body"]           = The definition of 'actions' to perform

Indices:clearCache (params)

Clear Cache function

Parameters:

• params

  The clear cache Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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)
       ["query"]              = (boolean) Clear query caches
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["recycler"]           = (boolean) Clear the recycler cache
       ["request"]            = (boolean) Clear request cache

Indices:deleteMapping (params)

Delete Mapping function

Parameters:

• params

  The delete mapping Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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)

Indices:getMapping (params)

Get Mapping function

Parameters:

• params

  The get mapping Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names
       ["type"]               = (list) A comma-separated list of document types
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:getFieldMapping (params)

Get Feild Mapping function

Parameters:

• params

  The get field mapping Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names
       ["type"]               = (list) A comma-separated list of document types
       ["fields"]             = (list) A comma-separated list of fields (Required)
       ["include_defaults"]   = (boolean) Whether the default mapping values should be returned as well
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:putMapping (params)

Put Mapping function

Parameters:

• params

  The put mapping Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names the mapping should be added to
       (supports wildcards); use '_all' or omit to add the mapping on all indices.
       ["type"]               = (string) The name of the document type (Required)
       ["timeout"]            = (time) Explicit operation timeout
       ["master_timeout"]     = (time) Specify timeout for connection to master
       ["ignore_unavailable"] = (boolean) Whether specified concrete indices should be ignored when unavailable
       (missing or closed)
       ["ignore_conflicts"]   = (boolean) Specify whether to ignore conflicts while updating the mapping
       (default: false)
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["update_all_types"]   = (boolean) Whether to update the mapping for all fields with the same name across
       all types or not
       ["body"]               = The mapping definition

Indices:getSettings (params)

Get Settings function

Parameters:

• params

  The get settings Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names; use '_all' or empty string to
       perform the operation on all indices
       ["name"]               = (list) The name of the settings that should be included
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       [open,closed])
       ["flat_settings"]      = (boolean) Return settings in flat format (default: false)
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["human"]              = (boolean) Whether to return version and creation date values in human-readable
       format. (default: false)

Indices:putSettings (params)

Put Settings function

Parameters:

• params

  The put settings Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names; use '_all' or empty string to
       perform the operation on all indices
       ["master_timeout"]     = (time) Specify timeout for connection to master
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["flat_settings"]      = (boolean) Return settings in flat format (default: false)
       ["body"]               = The index settings to be updated

Indices:deleteTemplate (params)

Delete Template function

Parameters:

• params

  The delete template Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["name"]           = (string) The name of the template (Required)
       ["timeout"]        = (time) Explicit operation timeout
       ["master_timeout"] = (time) Specify timeout for connection to master

Indices:existsTemplate (params)

Exists Template function

Parameters:

• params

  The exists template Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["name"]           = (string) The name of the template (Required)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:getTemplate (params)

Get Template function

Parameters:

• params

  The get template Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["name"]           = (list) The comma separated names of the index templates (Required)
       ["flat_settings"]  = (boolean) Return settings in flat format (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:putTemplate (params)

Put Template function

Parameters:

• params

  The put template Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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)
       ["create"]         = (boolean) Whether the index template should only be added if new or can also replace
       an existing one (default: false)
       ["timeout"]        = (time) Explicit operation timeout
       ["master_timeout"] = (time) Specify timeout for connection to master
       ["flat_settings"]  = (boolean) Return settings in flat format (default: false)
       ["body"]           = The template definition

Indices:existsType (params)

Exists Type function

Parameters:

• params

  The put template Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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"] = (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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:getUpgrade (params)

Get Upgrade function

Parameters:

• params

  The get upgrade Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]                 = (list) A comma-separated list of index names; use '_all' or empty string to
       perform the operation on all indices
       ["ignore_unavailable"]    = (boolean) Whether specified concrete indices should be ignored when
       unavailable (missing or closed)
       ["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
       ["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"]      = (enum) Whether to expand wildcard expression to concrete indices that are
       open, closed or both. (open,closed,none,all) (default: open)
       ["human"]                 = (boolean) Whether to return time and byte values in human-readable format.
       (default: false)

Indices:upgrade (params)

Upgrade function

Parameters:

• params

  The upgrade Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]                 = (list) A comma-separated list of index names; use '_all' or empty string to
       perform the operation on all indices
       ["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"]      = (enum) Whether to expand wildcard expression to concrete indices that are
       open, closed or both. (open,closed,none,all) (default: open)
       ["ignore_unavailable"]    = (boolean) Whether specified concrete indices should be ignored when
       unavailable (missing or closed)
       ["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

Indices:validateQuery (params)

Validate Query function

Parameters:

• params

  The validate query Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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
       ["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"]         = (enum) Whether to expand wildcard expression to concrete indices that are
       open, closed or both. (open,closed,none,all) (default: open)
       ["operation_threading"]      = TODO: ?
       ["q"]                        = (string) Query in the Lucene query string syntax
       ["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) (AND,OR)
       (default: OR)
       ["df"]                       = (string) The field to use as default where no field prefix is given in the
       query string
       ["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
       ["rewrite"]                  = (boolean) Provide a more detailed explanation showing the actual Lucene
       query that will be executed.
       ["source"]              = (string) The URL-encoded query definition (instead of using the request body)
       ["body"]                     = The query definition specified with the Query DSL

Indices:deleteWarmer (params)

Delete Warmer function

Parameters:

• params

  The delete warmer Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]          = (list) A comma-separated list of index names to delete warmers from (supports
       wildcards); use '_all' to perform the operation on all indices. (Required)
       ["name"]           = (list) A comma-separated list of warmer names to delete (supports wildcards); use
       '_all' to delete all warmers in the specified indices. You must specify a name either in the uri or in the
       parameters.
       ["master_timeout"] = (time) Specify timeout for connection to master

Indices:getWarmer (params)

Get Warmer function

Parameters:

• params

  The get warmer Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names to restrict the operation; use
       '_all' to perform the operation on all indices
       ["name"]               = (list) 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
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["local"]              = (boolean) Return local information, do not retrieve the state from master node
       (default: false)

Indices:putWarmer (params)

Put Warmer function

Parameters:

• params

  The put warmer Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names to register the warmer for; use
       '_all' or omit to perform the operation on all indices
       ["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
       ["master_timeout"]     = (time) Specify timeout for connection to master
       ["ignore_unavailable"] = (boolean) Whether specified concrete indices should be ignored when unavailable
       (missing or closed) in the search request to warm
       ["allow_no_indices"]   = (boolean) Whether to ignore if a wildcard indices expression resolves into no
       concrete indices in the search request to warm. (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, in the search request to warm. (open,closed,none,all) (default: open)
       ["request_cache"]      = (boolean) Specify whether the request to be warmed should use the request cache,
       defaults to index level setting
       ["body"]               = The search request definition for the warmer (query, filters, facets, sorting,
       etc)

Indices:exists (params)

Function to check whether an index exists or not

Parameters:

• params

  The exists Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"] = (list) A comma-separated list of indices to check (Required)

Indices:get (params)

Function to get an index

Parameters:

• params

  The get Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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)

Indices:delete (params)

Function to delete indices

Parameters:

• params

  The delete Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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

Indices:create (params)

Function to create an index

Parameters:

• params

  The create Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]   = (string) The name of the index (Required)
       ["timeout"] = (time) Explicit operation timeout
       ["body"]    = (time) Explicit operation timeout

Indices:optimize (params)

Function to optimize an index

Parameters:

• params

  The optimize Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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.

Indices:open (params)

Function to open an index

Parameters:

• params

  The open Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]   = (string) The name of the index (Required)
       ["timeout"] = (time) Explicit operation timeout

Indices:close (params)

Function to close an index

Parameters:

• params

  The open Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]   = (string) The name of the index (Required)
       ["timeout"] = (time) Explicit operation timeout

Indices:analyze (params)

Function to perform analysis process on a text

Parameters:

• params

  The analyze Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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
       ["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

Indices:refresh (params)

Function to refresh an index

Parameters:

• params

  The refresh Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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.

Indices:status (params)

Function to get the status of an index

Parameters:

• params

  The status Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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: ?

Indices:seal (params)

Function to seal an index

Parameters:

• params

  The seal Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]   = (string) The name of the index

Indices:flush (params)

Flush function

Parameters:

• params

  The flush Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]              = (list) A comma-separated list of index names; use '_all' or empty string for all
       indices
       ["force"]              = (boolean) Whether a flush should be forced even if it is not necessarily needed
       ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented
       even if no uncommitted changes are present. (This setting can be considered as internal)
       ["full"]               = (boolean) TODO: ?
       ["wait_if_ongoing"]    = (boolean) If set to true the flush operation will block until the flush can be
       executed if another flush operation is already executing. The default is false and will cause an exception to be
       thrown on the shard level if another flush operation is already running.
       ["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"]   = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)

Indices:forceMerge (params)

Force Merge function

Parameters:

• params

  The force merge Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 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)
       ["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"]     = (enum) Whether to expand wildcard expression to concrete indices that are
       open, closed or both. (open,closed,none,all) (default: open)
       ["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: ?
       ["wait_for_merge"]       = (boolean) Specify whether the request should block until the merge process is
       finished (default: true)

Indices:recovery (params)

Recovery function

Parameters:

• params

  The recovery Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]       = (list) A comma-separated list of index names; use '_all' or empty string to perform the
       operation on all indices
       ["detailed"]    = (boolean) Whether to display detailed information about shard recovery (default: false)
       ["active_only"] = (boolean) Display only those recoveries that are currently on-going (default: false)
       ["human"]       = (boolean) Whether to return time and byte values in human-readable format. (default:
       false)

Indices:segments (params)

Segments function

Parameters:

• params

  The segments Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]               = (list) A comma-separated list of index names; use '_all' or empty string to
       perform the operation on all indices
       ["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"]    = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["human"]               = (boolean) Whether to return time and byte values in human-readable format.
       (default: false)
       ["operation_threading"] = TODO: ?
       ["verbose"]             = (boolean) Includes detailed memory usage by Lucene. (default: false)

Indices:shardStores (params)

Shard Stores function

Parameters:

• params

  The shard stores Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]               = (list) 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 (green,yellow,red,all)
       ["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"]    = (enum) Whether to expand wildcard expression to concrete indices that are open,
       closed or both. (open,closed,none,all) (default: open)
       ["operation_threading"] = TODO: ?

Indices:stats (params)

Stats function

Parameters:

• params

  The stats Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]             = (list) A comma-separated list of index names; use '_all' or empty string to
       perform the operation on all indices
       ["metric"]            = (list) Limit the information returned the specific metrics.
       ["completion_fields"] = (list) A comma-separated list of fields for 'fielddata' and 'suggest' index
       metric (supports wildcards)
       ["fielddata_fields"]  = (list) A comma-separated list of fields for 'fielddata' index metric (supports
       wildcards)
       ["fields"]            = (list) A comma-separated list of fields for 'fielddata' and 'completion' index
       metric (supports wildcards)
       ["groups"]            = (list) A comma-separated list of search groups for 'search' index metric
       ["human"]             = (boolean) Whether to return time and byte values in human-readable format.
       (default: false)
       ["level"]             = (enum) Return stats aggregated at cluster, index or shard level
       (cluster,indices,shards) (default: indices)
       ["types"]             = (list) A comma-separated list of document types for the 'indexing' index metric