Streams

Search…
Streams
Streams are 'message stores', each stream defines how messages are stored and what the limits (duration, size, interest) of the retention are. Streams consume normal NATS subjects, any message published on those subjects will be captured in the defined storage system. You can do a normal publish to the subject for unacknowledged delivery, though it's better to use the JetStream publish calls instead as the JetStream server will reply with an acknowledgement that it was successfully stored.
Orders
In the diagram above we show the concept of storing all ORDERS.* in the Stream even though there are many types of order related messages. We'll show how you can selectively consume subsets of messages later. Relatively speaking the Stream is the most resource consuming component so being able to combine related data in this manner is important to consider.
Streams can consume many subjects. Here we have ORDERS.* but we could also consume SHIPPING.state into the same Stream should that make sense (not shown here).
Streams support various retention policies which define when messages in the stream can be automatically deleted, such as when stream limits are hit (like max count, size or age) - if the discard policy is set to 'discard old' - or also more novel options that apply on top of the limits such as 'interest' (automatically deleted after all consumers have received acknowledgement of the delivery of the message to client applications) and 'working queue' (where a message is automatically deleted from the stream when the consumer receives acknowledgement of its consumption from the client application).
Streams support deduplication using a Nats-Msg-Id header and a sliding window within which to track duplicate messages. See the Message Deduplication section.
When defining Streams the items below make up the entire configuration of the set.
Item
Description
Name
A name for the Stream that may not have spaces, tabs, period (.), greater than (>) or asterisk (*). See naming.
Storage
The type of storage backend, File and Memory
Subjects
A list of subjects to consume, supports wildcards
Replicas
How many replicas to keep for each message in a clustered JetStream, maximum 5
MaxAge
Maximum age of any message in the Stream, expressed in nanoseconds.
MaxBytes
How many bytes the Stream may contain. Adheres to Discard Policy, removing oldest or refusing new messages if the Stream exceeds this size
MaxMsgs
How many messages may be in a Stream. Adheres to Discard Policy, removing oldest or refusing new messages if the Stream exceeds this number of messages
MaxMsgSize
The largest message that will be accepted by the Stream
MaxConsumers
How many Consumers can be defined for a given Stream, -1 for unlimited
NoAck
Disables acknowledging messages that are received by the Stream
Retention
How message retention is considered, LimitsPolicy (default), InterestPolicy or WorkQueuePolicy
Discard
When a Stream reaches it's limits either, DiscardNew refuses new messages while DiscardOld (default) deletes old messages
Duplicates
The window within which to track duplicate messages, expressed in nanoseconds.
NATS Concepts - Previous
JetStream
Consumers
Last modified 1mo ago
Export as PDF
Copy link
Edit on GitHub