stream replica edit

Modifies the way in which messages are replicated from one stream to another.

Permission required to run this command: Your user ID must have the adminperm permission on the stream that is specified by the -path parameter.
Note: The mapr user is not treated as a superuser. MapR Streams 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
stream replica edit
	 -path stream path 
	 -replica remote stream path 
	[ -newreplica renamed stream path ]
	[ -throttle throttle replication operations under load ]
	[ -networkencryption enable on-wire encryption ]
	[ -synchronous replicate to remote stream before acknowledging producers ]
	[ -networkcompression on-wire compression type: off|lz4|lzf|zlib ]
REST http[s]://<host>:<port>/rest/stream/replica/edit?path=<path>&replica=<name>

Parameters

Parameter Description
path The path and name of the stream that you want to create a replica for.
replica The path and name of the stream that you want to create as a replica of the stream that you specified with the -path parameter.
newreplica Specifies a new name to give to the replica stream.
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. The default is false.
Throttling has two effects, both of which allow MapR Streams to use more system resources to process new messages:
  • Throttling slows down the rate at which changes to a stream are replicated.
  • Throttling slows down the rate at which messages to be replicated are read from disk.
networkencryption A boolean value that specifies whether or not to enable on-wire encryption. The values are true or false. The default is false. If you set the value 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. The default is false and specifies asynchronous replication.
networkcompression Specifies the type of compression to use when replicating messages. For more information, see Compression.