stream edit

Edits the values of parameters for the specified stream.

Permissions Required

To run this command, your user ID must have the following permissions:
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 edit
	 -path Stream Path 
	[ -ttl <Time to live in seconds> ]
	[ -autocreate true|false ]
	[ -defaultpartitions <Default partitions per topic> ]
	[ -compression off|lz4|lzf|zlib ]
	[ -produceperm <Producer access control expression> default u:creator ]
	[ -consumeperm <Consumer access control expression> default u:creator ]
	[ -topicperm <Topic CRUD access control expression> default u:creator ]
	[ -copyperm <Stream copy access control expression> default u:creator ]
	[ -adminperm <Stream administration access control expression> default u:creator ]
REST http[s]://<host>:<port>/rest/stream/edit?path=<path>

Parameters

Parameter Description
path The path and name of the stream to create.
ttl Specifies the number of seconds to elapse between the publication of a message in a topic in this stream and the expiration of that message.

Consumers do not see messages that have expired.

Messages that have expired are deleted during the next purge process. See Setting the Time-to-Live for Messages for details.

A value of 0 causes messages to be retained indefinitely.

autocreate Specifies whether to create a topic automatically when a producer tries to write the first message to it. Values are true and false. The default is true.
defaultpartitions Specifies the default number of partitions to allocate to new topics in the stream.
compression

Specifies the compression setting to use for the stream. Producer client libraries can bundle messages that are to be published on the same partition and compress them. The messages are sent to the server compressed, are stored compressed, are replicated to other containers compressed, and (if stream replication is configured) replicated to replica streams compressed. Consumer client libraries receive compressed data, decompresses it, and passes it to client applications.

Valid options are off, lzf, lz4, and zlib. The default setting is the type of compression that is set for the directory in which the stream is located.

For more information, see Compression.

produceperm Specifies the access-control expression that controls who can publish messages to topics in the stream. See ACE Syntax.
consumeperm Specifies the access-control expression that controls who can who can listen to topics in the stream. See ACE Syntax.
topicperm Specifies the access-control expression that controls who can create, edit, or remove topics in the stream. See ACE Syntax.
copyperm Specifies the access-control expression that controls who can use mapr copystream or mapr diffstreams on the stream. See ACE Syntax.
adminperm Specifies the access-control expression that controls who can can modify the other access-control expressions for the stream, set up replication from the stream, and modify attributes of the stream. See ACE Syntax.

This permission includes the topicperm permission.