jetstream v0.0.1

View Source Jetstream.API.KV (jetstream v0.0.1)

API for interacting with the Key/Value store functionality in Nats Jetstream.

Learn about the Key/Value store: https://docs.nats.io/nats-concepts/jetstream/key-value-store

Link to this section Summary

Types

bucket_options()

Functions

create_bucket(conn, bucket_name, params \\ [])

Create a new Key/Value bucket. Can include the following options

create_key(conn, bucket_name, key, value)

Create a Key in a Key/Value Bucket

delete_bucket(conn, bucket_name)

Delete a Key/Value bucket

delete_key(conn, bucket_name, key)

Delete a Key from a K/V Bucket

get_value(conn, bucket_name, key)

Get the value for a key in a particular K/V bucket

purge_key(conn, bucket_name, key)

Purge a Key from a K/V bucket. This will remove any revision history the key had

put_value(conn, bucket_name, key, value)

Put a value into a Key in a K/V Bucket

Link to this section Types

Link to this type

bucket_options()

View Source 
@type bucket_options() ::
  {:history, non_neg_integer()}
  | {:ttl, non_neg_integer()}
  | {:max_bucket_size, non_neg_integer()}
  | {:max_value_size, non_neg_integer()}
  | {:description, binary()}
  | {:replicas, non_neg_integer()}
  | {:storage, :file | :memory}
  | {:placement, Jetstream.API.Stream.placement()}

Link to this section Functions

Link to this function

create_bucket(conn, bucket_name, params \\ [])

View Source 
@spec create_bucket(
  conn :: Gnat.t(),
  bucket_name :: binary(),
  params :: [bucket_options()]
) ::
  {:ok, Jetstream.API.Stream.info()} | {:error, any()}

Create a new Key/Value bucket. Can include the following options

  • :history - How many historic values to keep per key (defaults to 1, max of 64)
  • :ttl - How long to keep values for (in nanoseconds)
  • :max_bucket_size - The max number of bytes the bucket can hold
  • :max_value_size - The max number of bytes a value may be
  • :description - A description for the bucket
  • :replicas - How many replicas of the data to store
  • :storage - Storage backend to use (:file, :memory)
  • :placement - A map with :cluster (required) and :tags (optional)

examples

 Examples

iex>{:ok, info} = Jetstream.API.KV.create_bucket(:gnat, "my_bucket")

Link to this function

create_key(conn, bucket_name, key, value)

View Source 
@spec create_key(
  conn :: Gnat.t(),
  bucket_name :: binary(),
  key :: binary(),
  value :: binary()
) :: :ok

Create a Key in a Key/Value Bucket

examples

 Examples 

iex>:ok = Jetstream.API.KV.create_key(:gnat, "my_bucket", "my_key", "my_value")
Link to this function

delete_bucket(conn, bucket_name)

View Source 
@spec delete_bucket(conn :: Gnat.t(), bucket_name :: binary()) ::
  :ok | {:error, any()}

Delete a Key/Value bucket

examples

 Examples

iex>:ok = Jetstream.API.KV.delete_bucket(:gnat, "my_bucket")

Link to this function

delete_key(conn, bucket_name, key)

View Source 
@spec delete_key(conn :: Gnat.t(), bucket_name :: binary(), key :: binary()) :: :ok

Delete a Key from a K/V Bucket

examples

 Examples 

iex>:ok = Jetstream.API.KV.delete_key(:gnat, "my_bucket", "my_key")
Link to this function

get_value(conn, bucket_name, key)

View Source 
@spec get_value(conn :: Gnat.t(), bucket_name :: binary(), key :: binary()) ::
  binary() | {:error, any()}

Get the value for a key in a particular K/V bucket

examples

 Examples 

iex>"my_value" = Jetstream.API.KV.get_value(:gnat, "my_bucket", "my_key")
Link to this function

purge_key(conn, bucket_name, key)

View Source

Purge a Key from a K/V bucket. This will remove any revision history the key had

examples

 Examples 

iex>:ok = Jetstream.API.KV.purge_key(:gnat, "my_bucket", "my_key")
Link to this function

put_value(conn, bucket_name, key, value)

View Source 
@spec put_value(
  conn :: Gnat.t(),
  bucket_name :: binary(),
  key :: binary(),
  value :: binary()
) :: :ok

Put a value into a Key in a K/V Bucket

examples

 Examples 

iex>:ok = Jetstream.API.KV.put_value(:gnat, "my_bucket", "my_key", "my_value")