stream create
Creates a new stream.
maprcli stream edit
.To see the value of a stream's parameters, use the
command maprcli stream info
.
To run this command, your user ID must have write permission on the directory in which you want to create a stream.
Permissions Required
To run this command, your user ID must have the following permissions:- readAce and writeAce on the volume
- lookupdir on directories in the path
mapr
user is not treated as a superuser. HPE Ezmeral Data Fabric 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 |
|
REST | http[s]://<host>:<port>/rest/stream/create?path=<path> |
Parameters
Parameter | Description |
---|---|
path |
The path and name of the stream to create. The path to the stream can
include any character allowed by Data Fabric. For
example, The name of the stream cannot include a colon ( : ) or a forward slash ( / ). |
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 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 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 |
Determines which users can modify ACEs for a stream, set up replication of a
stream, and modify other attributes of a stream. By default,
the stream owner and the Data Fabric
user can modify this setting. See ACE Syntax. This permission includes the |
copymetafrom |
If you plan to replicate messages to this stream from another stream, specify the path to that other stream. The metadata from that stream will be copied to the new stream when the new stream is created. |
ischangelog |
Specifies whether the stream is for the Change Data Capture feature's changed
data records. Value: true|false. Default: false.
|
defaulttimestamptype |
Specifies the type of timestamp stored in the topic's message. Value:
createtime | logappendtime Default: createtime. The topic inherits the default value
from the stream unless the topic sets the timestamp type to a different value. A
A
|
pidexpirysecs |
Specifies the expiration time for the Producer ID. This parameter fixes the lifetime for the Producer ID. Default: 604800 |
mincompactionlag |
Sets the minimum delay (in milliseconds) before which messages are
not compacted. It is the minimum time that the messages are
available for consumption. Beyond this time period, the messages may be
compacted. Default: 0 The lag is calculated from the time that a message was produced to the stream topic-partition. NOTE Compaction is set only when you
edit the stream. See stream edit. |
deleteretention |
Sets the minimum time (in milliseconds) before which deleted records are
removed. It is the minimum time that the deleted records are still available.
Beyone this time period, the deleted messages may be removed. Default:
86400000 Used with log compaction. |