nats_stream (enats v1.1.0)

View Source

Summary

Types

ExternalStream allows you to qualify access to a stream source in another account.

Placement is used to guide placement of streams in clustered JetStream.

RePublish is for republishing messages once committed to a stream. The original subject is remapped from the subject pattern to the destination pattern.

StreamSource dictates how streams can source from other streams.

SubjectTransformConfig is for applying a subject transform (to matching messages) before doing anything else when a new message is received.

Types

external_stream()

-type external_stream() :: #{api := binary(), deliver => binary()}.

ExternalStream allows you to qualify access to a stream source in another account.

placement()

-type placement() :: #{cluster := binary(), tags => [binary()]}.

Placement is used to guide placement of streams in clustered JetStream.

republish()

-type republish() :: #{src => binary(), dest => binary(), headers_only => boolean()}.

RePublish is for republishing messages once committed to a stream. The original subject is remapped from the subject pattern to the destination pattern.

stream_source()

-type stream_source() ::
          #{name := binary(),
            opt_start_seq => non_neg_integer(),
            opt_start_time => binary(),
            filter_subject => binary(),
            subject_transforms => [subject_transform_config()],
            external => external_stream(),
            domain => binary()}.

StreamSource dictates how streams can source from other streams.

subject_transform_config()

-type subject_transform_config() :: #{src => binary(), dest => binary()}.

SubjectTransformConfig is for applying a subject transform (to matching messages) before doing anything else when a new message is received.

Functions

create/3

create(Conn, Name, Config, Opts)

delete(Conn, Name)

delete(Conn, Name, Opts)

get(Conn, Name)

get(Conn, Name, Opts)

list(Conn)

list(Conn, Opts)

list(Conn, Request, Opts)

msg_delete(Conn, Name, SeqNo)

msg_delete/4

msg_delete(Conn, Name, SeqNo, NoErase, Opts)

msg_get/3

msg_get(Conn, Name, Msg, Opts)

names(Conn)

names(Conn, Opts)

names(Conn, Request, Opts)

purge(Conn, Name)

purge(Conn, Name, Opts0)

purge(Conn, Name, Msg, Opts)

types/1

update/3