class NATS::KV::Client

• NATS::KV::Client
• Reference
• Object

Defined in:

Constructors

• .new(nats : NATS::Client)

Instance Method Summary

• #create(bucket : String, key : String, value : String | Bytes) : Int64 | Nil

  Create a key in the given bucket with the specified value.

• #create_bucket(name : String, description : String = "", *, max_value_size : Int32 | Nil = nil, history : Int = 1, ttl : Time::Span | Nil = nil, max_bytes : Int64 | Nil = nil, storage : JetStream::StreamConfig::Storage = :file, replicas : Int32 = 1, discard_new_per_key : Bool = false, placement : JetStream::StreamConfig::Placement | Nil = nil, allow_msg_ttl : Bool | Nil = nil) : Bucket

  Create a NATS::KV::Bucket to store key/value mappings in with the specified name.

• #delete(bucket : String, key : String)
• #delete(bucket : Bucket)
• #delete_bucket(bucket : String)
• #each_key(bucket : String, pattern : String = ">", &) : Nil
• #get(bucket : String, key : String, *, revision : Int | Nil = nil, ignore_deletes : Bool = false) : Entry | Nil

  Get the KV::Entry for the given key in bucket, or nil if the key does not exist.

• #get_bucket(name : String) : Bucket | Nil

  Get the Bucket with the given name, or nil if that bucket does not exist.

• #history(bucket : String, key : String) : Array(Entry)

  Get all of the currently retained history for the given key in the given bucket name.

• #keys(bucket : String, pattern : String = ">") : Set(String)

  Get all of the keys matching pattern for the given bucket name.

• #list_buckets(pattern : String)
• #purge(bucket : String, key : String)
• #put(bucket : String, key : String, value : String | Bytes, ttl : Time::Span | Nil = nil) : Int64

  Assign value to key in bucket, returning an acknowledgement or error if the key could not be set.

• #set(bucket : String, key : String, value : Data, ttl : Time::Span | Nil = nil)

  Assign value to key in bucket without waiting for acknowledgement from the NATS server.

• #update(bucket : String, key : String, value : String | Bytes, revision : Int) : Int64 | Nil

  Update a bucket's key with the specified value only if the current value is the specified revision.

• #watch(bucket : String, key : String, *, ignore_deletes = false, include_history = false)

Constructor Detail

Instance Method Detail

if revision = kv.create("my-bucket", "my-key", "my-value")
  # created
else
  # key already existed and value was not set
end

kv.set "config", "name", "1"
kv.history("config", "name")

if revision = kv.update(bucket, key, value, revision)
  # updated
else
  # outdated revision
end