table replica add

Registers a binary table as a replica of another binary table.

Note: You do not need to use this command it you use the table replica autosetup command.

Syntax

CLI
maprcli table replica add
-path table path
-replica replica table path
[ -columns comma separated list of <family>[:<column>]  ]
[ -paused is replication paused. default: false ]
[ -throttle throttle replication ops. default: false ]
[ -networkencryption enable on-wire encryption. default: false ]
[ -synchronous is synchronous replication. default: false ]
[ -networkcompression on-wire compression type: off|on|lzf|lz4|zlib. default: on ]
REST
http[s]://<host>:<port>/rest/table/replica/add?path=<path>&replica=<name>...
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 source table that you want to replicate.

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

The path to the replica.

  • For a table on the local cluster, start the path at the volume mount point. For example, for a table named testdst under a volume with a mount point at /volume1, specify the following path: /volume1/testdst
  • For a table on a remote cluster, you must also specify the cluster name in the path. For example, for a table named customerdst under volume1 in the sanfrancisco cluster, specify the following path: /mapr/sanfrancisco/volume1/customerdst
Note: For replication to a table, the command will fail if the table in the replica path does not exist.
columns

By default, all columns in the source table are replicated. If you do not want to replicate all columns in the table, you can specify specific columns to replicate. Provide a comma-separated list of column families or columns from a certain column family (column family:qualifier). For example, use the following syntax to replicate the column family purchases and the column stars in the reviews column family: -columns purchases,reviews:stars

paused

A Boolean value that specifies whether to pause the replication so that it does not start immediately. The replication can be resumed using the replica resume command at a later time. The values are true or false. Not paused (false) is the default.

throttle 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.
networkencryption A Boolean value that specifies whether or not to enable on-wire encryption. The values are true or false. No encryption (false) is the default. If you set this to true, the local cluster and any other cluster that is part of the replication process must be enabled for security.
synchronous

A Boolean value that specifies whether replication is synchronous or asynchronous. The values are true or false. Asynchronous (false) is the default.

networkcompression

The type of on-wire compression.

The types are:

  • off
  • on (default)
  • lzf
  • lz4
  • zlib

lz4 is the default compression which it set by parameter values on or lz4.

Example

Register a table on the local cluster as a replica of another table on the local cluster:

CLI
maprcli table replica add -path /volume1/custA -replica /volume2/custA
REST

https://<host>:<port>/rest/table/replica/add?path=%2Fvolume1%2FcustA&replica=%2Fvolume2%2FcustA