ldoc

• Index

Contents

• Methods

Classes

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

Modules

• elasticsearch
• helper

Class Cat

The Cat class

Info:

• Author: Dhaval Kapil

Methods

Cat:aliases (params)	Function to show information about currently configured aliases
Cat:allocation (params)	Function to provide a snapshot about number of shards
Cat:count (params)	Function to provide quick access to document count of entire cluster, or individual indices
Cat:fielddata (params)	Function to get usage of heap memory
Cat:health (params)	Function to get health
Cat:help (params)	Help function
Cat:indices (params)	Indices function
Cat:master (params)	Master function
Cat:nodeAttrs (params)	NodeAttrs function
Cat:nodes (params)	Nodes function
Cat:pendingTasks (params)	PendingTasks function
Cat:plugins (params)	Plugins function
Cat:recovery (params)	Recovery function
Cat:repositories (params)	Repositories function
Cat:segments (params)	Segments function
Cat:shards (params)	Shards function
Cat:snapshots (params)	Snapshots function
Cat:threadPool (params)	Thread pool function

Methods

Cat:aliases (params)

Function to show information about currently configured aliases

Parameters:

• params

  The aliases Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["name"]           = (list) A comma-separated list of alias names to return
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:allocation (params)

Function to provide a snapshot about number of shards

Parameters:

• params

  The allocation Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["node_id"]        = (list) A comma-separated list of node IDs or names to limit the returned information
       ["bytes"]          = (enum) The unit in which to display byte values (b,k,m,g)
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information
       ["v"]              = (boolean) Verbose mode. Display column headers

Cat:count (params)

Function to provide quick access to document count of entire cluster, or individual indices

Parameters:

• params

  The allocation Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]          = (list) A comma-separated list of index names to limit the returned information
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false) 

Cat:fielddata (params)

Function to get usage of heap memory

Parameters:

• params

  The fielddata Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["fields"]         = (list) A comma-separated list of fields to return in the output
       ["bytes"]          = (enum) The unit in which to display byte values (b,k,m,g)
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:health (params)

Function to get health

Parameters:

• params

  The health Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["ts"]             = (boolean) Set to false to disable timestamping (default: true)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:help (params)

Help function

Parameters:

• params

  The help Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["help"] = (boolean) Return help information(default: false)

Cat:indices (params)

Indices function

Parameters:

• params

  The indices Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]          = (list) A comma-separated list of index names to limit the returned information
       ["bytes"]          = (enum) The unit in which to display byte values (b,k,m,g)
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["pri"]            = (boolean) Set to true to return stats only for primary shards (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:master (params)

Master function

Parameters:

• params

  The master Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:nodeAttrs (params)

NodeAttrs function

Parameters:

• params

  The nodeAttrs Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:nodes (params)

Nodes function

Parameters:

• params

  The nodes Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:pendingTasks (params)

PendingTasks function

Parameters:

• params

  The pendingTasks Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:plugins (params)

Plugins function

Parameters:

• params

  The plugins Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat: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 to limit the returned information
       ["bytes"]          = (enum) The unit in which to display byte values (b,k,m,g)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:repositories (params)

Repositories function

Parameters:

• params

  The repositories Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat: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 to limit the returned information
       ["h"]     = (list) Comma-separated list of column names to display
       ["help"]  = (boolean) Return help information (default: false)
       ["v"]     = (boolean) Verbose mode. Display column headers (default: false)

Cat:shards (params)

Shards function

Parameters:

• params

  The shards Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["index"]          = (list) A comma-separated list of index names to limit the returned information
       ["bytes"]          = (enum) The unit in which to display byte values
       ["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)

Cat:snapshots (params)

Snapshots function

Parameters:

• params

  The snapshots Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["repository"]         = (list) Name of repository from which to fetch the snapshot information (Required)
       ["local"]              = (bool) Return local information, do not retrieve the state from master node
       (default: false)
       ["ignore_unavailable"] = (boolean) Set to true to ignore unavailable snapshots (default: false)
       ["master_timeout"]     = (time) Explicit operation timeout for connection to master node
       ["h"]                  = (list) Comma-separated list of column names to display
       ["help"]               = (boolean) Return help information (default: false)
       ["v"]                  = (boolean) Verbose mode. Display column headers (default: false)

Cat:threadPool (params)

Thread pool function

Parameters:

• params

  The threadPool Parameters
  

Returns:

table Error or the data received from the elasticsearch server

Usage:

 params["local"]          = (boolean) Return local information, do not retrieve the state from master node
       (default: false)
       ["master_timeout"] = (time) Explicit operation timeout for connection to master node
       ["h"]              = (list) Comma-separated list of column names to display
       ["help"]           = (boolean) Return help information (default: false)
       ["v"]              = (boolean) Verbose mode. Display column headers (default: false)
       ["full_id"]        = (boolean) Enables displaying the complete node ids (default: false)