table replica elasticsearch edit
Edits the mapping of a MapR-DB source binary table to an Elasticsearch type.
The user that runs the command must have the following permissions granted through access control expressions on the source table:
- Permission to perform column-family and column reads, which is granted with the
readperm
access control expression. - Permission to perform replication, which is granted with the
replperm
access control expression.
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.Syntax
- CLI
-
maprcli table replica elasticsearch edit -path source table path -target Target cluster name -index Elasticsearch index name -type Elasticsearch type name [ -conversionclass Conversion class name ] [ -conversionjar Path to conversion class JAR file ] [ -columns comma separated list of <family>[:<column>] ] [ -throttle throttle replication ops. default: false ] [ -networkencryption enable on-wire encryption. default: false ] [ -networkcompression on-wire compression type: off|on|lzf|lz4|zlib. default: on ]
- REST
-
http[s]://<host>:<port>/rest/table/replica/elasticsearch/edit?path=<path>&target=<Name of Elasticsearch cluster>&index=<Name of index>&type=<Name of type>...
Parameters
Parameter |
Description |
---|---|
|
The path to the MapR-DB table.
|
|
The name of the Elasticsearch cluster in which the index and type are located. This name is the name specified for the cluster when it was registered with the current MapR cluster. |
|
The name of the Elasticsearch index in which the type is located. |
|
The name of the Elasticsearch type that updates to the MapR-DB source table are being replicated to. |
|
The name of the Java class that extends the MapR-provided interface
If use this parameter, you must also use the
|
|
The path to the JAR file in which the class specified by the
|
|
A comma-separated list of column families and specific columns within column families. This list indicates which columns to replicate to the Elasticsearch type that is specified by the type parameter. To replicate all columns within a column family, provide the name of the column family. To replicate particular columns within a column family, provide the name of the column family and the name of the column. Separate the two with a colon. For example, the following list causes the replication of all columns in
the column family
If you change the list by removing any columns or column families that have already been replicated to the Elasticsearch type, those columns and column families are not deleted from the type. MapR-DB replicates updates only; it does not replicate deletions or remove data from Elasticsearch types. If you do not want to keep the data in the type, follow these steps:
NOTE: To copy the content of the source table into the type, the
maprcli table replica elasticsearch autosetup command
starts a MapReduce job. The length of the job depends on the size of the
source table and the number of columns that you are indexing. Moreover,
the volume of data and the speed at which the Elasticsearch type is
populated could perceptibly slow the performance of other processes
running at the same time on the Elasticsearch cluster. The less data
there is to copy to the type, the faster the MapReduce job will end and
the fewer resources the job will consume on the Elasticsearch cluster.
|
|
A Boolean value that specifies whether to throttle replication operations. Throttle the replication stream to minimize the impact of the replication process on incoming operations during periods of heavy load. The values are true or false. No throttle (false) is the default. |
|
A Boolean value that specifies whether or not to enable on-wire
encryption. The values are NOTE: Data is encrypted only until it reaches a MapR gateway. From the
gateway to an Elasticsearch cluster, this parameter has no effect.
|
|
The type of on-wire compression. The types are:
lz4 is the default compression which it set by the parameter values
NOTE: Data is compressed only until it reaches a MapR gateway. From the
gateway to an Elasticsearch cluster, this parameter has no effect.
|