Skip to main content

Getting Started with the Metadata Key-Value Store

Available through: CLI, Python SDK, Rust SDK, API

The Metadata KVS supports 4 primary operations set, get, update, and delete.

Setting a key-value pair

You can set a key-value pair through any of the available interfaces by supplying it with a key and a value. For more information see setting a key-value pair.

seaplane metadata set <KEY> <VALUE>

For larger values such as public keys, large text files, or blobs of data you can use @- to load values from STDIN.

seaplane metadata set <key> @- < <file>

Alternatively, you can use @<path/to/my/file> to directly load values from a file.

seaplane metadata set <key> @<path/to/my/file>

Retrieving a key-value pair

You can retrieve a key-value pair through any of the available interfaces by supplying it with a key. For more information, see get a key-value pair.

Keys and values are sent to the API base64 encoded. If you have values that can be printed to a terminal safely, use the --decode or -D flag to automatically decode your key-value pair.

seaplane metadata get <KEY> --decode

Deleting a key-value pair

Deleting a key-value pair permanently removes it from the coordination service. All key-value pairs are strongly consistent and deployed on multiple cloud services to survive outages and data loss. However, Seaplane does not keep a record of deleted key-value pairs. Executing a delete query on the Metadata KVS permanently removes the key-value pair.

For more information see, deleting a key-value pair.

seaplane metadata delete <KEY>

Working with the command line interface (CLI)