table replica elasticsearch list

Lists the Elasticsearch types and the associated replication statistics for a specified binary table.

By default, statistics are updated every five minutes.

Syntax

CLI
maprcli table replica elasticsearch list 
   -path <table path >
   [ -refreshnow <immediately refresh the replication statistics> default: false ]
REST

http[s]://<host>:<port>/rest/table/replica/elasticsearch/list?path=<path>...

Note: The mapr user is not treated as a superuser. MapR-DB does not allow the mapr user to run this command unless that user is given the relevant permission or permissions with access-control expressions.

Parameters

Parameter

Description

path

The path to the table that you want to list the Elasticsearch types for.

  • For a path on the local cluster, start the path at the volume mount point. For example, for a table named test under a volume with a mount point at /volume1, specify the following path: /volume1/test
  • For a path on a remote cluster, you must also specify the cluster name in the path. For example, for a table named customer under volume1 in the sanfrancisco cluster, specify the following path: /mapr/sanfrancisco/volume1/customer

refreshnow

A Boolean value that specifies if you want to trigger an immediate update of the replication statistics. The values are true or false. By default, the value is false; the command lists the current version of the replication statistics, which could be a maximum of five minutes old.

Output

Lists information about each Elasticsearch type for the specified table.

Output Data Fields

The following fields are displayed for each Elasticsearch type:

Field

Description

cluster

The cluster on which the source MapR-DB table resides.

target

The name of the Elasticsearch cluster in which the type is located. This is the name specified for the cluster when it was registered with the current MapR cluster.

index

The name of the Elasticsearch index in which the type is located.

type

The name of the Elasticsearch type that the source MapR-DB table is being replicated to.

paused

A Boolean values that specifies if replication is paused.

throttle

A Boolean value that specifies if replication is throttled.

idx

The internal index value.

networkencryption

A Boolean value that specifies whether replication is encrypted from the source table to the MapR gateways.

networkcompression

The type of on-wire compression.

isUptodate

A Boolean value that specifies whether the Elasticsearch type is up-to-date.

minPendingTS

The epoch time in milliseconds of the oldest operation that has yet to be replicated to the Elasticsearch type.

maxPendingTS

The epoch time in milliseconds of the newest operation that has yet to be replicated to the Elasticsearch type.

bytesPending

The number of bytes that have yet to be replicated to the Elasticsearch type.

putsPending

The number of puts that have yet to be replicated to the Elasticsearch type.

bucketsPending

The number of buckets that have yet to be replicated to the Elasticsearch type.

uuid

The table UUID.

Sample Output
{
     "timestamp":1432664030251,
     "timeofday":"2015-05-26 11:13:50.251
GMT-0700",
     "status":"OK",
     "total":1,
     "data":[
     {
   "cluster":"myMapRCluster",
   "target":"myESCluster",
   "index":"myIndex",
   "type":"myType",
   "paused":false,
   "throttle":false,
   "idx":1,
        
              
"networkencryption":false,
   "networkcompression":"lz4",
   "isUptodate":true,
   "minPendingTS":0,
   "maxPendingTS":0,
   "bytesPending":0,
                  
"putsPending":0,
          
"bucketsPending":0,
   "uuid":"e093f065-0ee9-27fa-8cef-08a6b7645500"
            
     }
     ]
}

Example

Lists Elasticsearch types that the custA table is being replicated to:

CLI

maprcli table replica elasticsearch list -path /volume1/custA

REST

https://<hostIP>:8443/rest/table/replica/elasticsearch/list?path=%2Fvolume1%2FcustA