NATS JetStream

Streamnats-jetstream

Persistence layer for NATS providing globally ordered, Raft-replicated streams.

Provider
default
Kind
Stream
Category
Messaging
Properties · 6 set by this component
propertytypevaluesrequiredkind defaultthis component
acksenumnone | leader | quorum | allno—▸ quorum
compactionboolean—nofalseinherited
deliveryenumat-most-once | at-least-once | exactly-oncenoat-least-once▸ at-least-once
idempotentProducer · advancedboolean—nofalseinherited
managedboolean—nofalse▸ false
minInsyncReplicasinteger—no—inherited
orderingenumper-key | globalnoper-key▸ global
partitionsinteger—no—inherited
replicationFactorinteger—no—▸ 1
retentionHoursinteger—no—inherited
retentionPolicy · component propertyenumlimits | interest | work-queuenolimitsinherited
schemaEnforcedboolean—nofalseinherited
storageenumephemeral | persistentnopersistent▸ persistent
transactions · advancedboolean—nofalseinherited
Rules that apply · 0

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

No rule reads this kind yet. That is a gap, not a guarantee.
Use it in a design
nodes:
  - { id: "nats-jetstream", component: "nats-jetstream" }
Other Stream products · 18
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# NATS JetStream: persistence layer on NATS. A stream is a single globally ordered sequence (no partitions),
# file storage and 1 replica by default, Raft-replicated when replicas > 1; retention unlimited unless limits set.
schemaVersion: "1"
type: "component"
id: "nats-jetstream"
kind: "stream"
provider: "default"
docs: "https://docs.nats.io/nats-concepts/jetstream"
defaults:
  delivery: "at-least-once"
  ordering: "global"
  replicationFactor: 1
  acks: "quorum"
  storage: "persistent"
  managed: false
properties:
  retentionPolicy:
    type: "enum"
    values: ["limits", "interest", "work-queue"]
    default: "limits"

The same page as markdown, for an agent: /catalogue/components/nats-jetstream.md