Key/Value

Nitric provides a simple way to work with key/value stores in your applications. Key/value stores are perfect for storing and retrieving data using unique keys, with fast access times and simple data structures.

Quick Start

Here's a minimal example to get you started:

import { kv } from '@nitric/sdk'

const store = kv('my-store').allow('get', 'set')

// Store a value
await store.set('user-1', { name: 'John', age: 30 })

// Retrieve a value
const user = await store.get('user-1')

Core Concepts

Key/Value Store

A key/value store is a database that stores data as key-value pairs. Each value is accessed using a unique key, making lookups fast and efficient.

Permissions

Key/value stores require explicit permissions for operations:

• get: Read values or list keys
• set: Create or update values
• delete: Remove values

Keys and Values

• Keys: Unique strings that identify values
• Values: Any JSON-serializable data (objects, arrays, strings, numbers, etc.)

Common Operations

Setting Values

const store = kv('my-store').allow('set')

// Create or update a value
await store.set('user-1', { name: 'John', age: 30 })

Getting Values

const store = kv('my-store').allow('get')

const user = await store.get('user-1')

Deleting Values

const store = kv('my-store').allow('delete')

await store.delete('user-1')

Listing Keys

const store = kv('my-store').allow('get')

// List all keys
for await (const key of store.keys()) {
  console.log(key)
}

// List keys with prefix
for await (const key of store.keys('user-')) {
  console.log(key)
}

Cloud Provider Support

Each cloud provider comes with a set of default services used when deploying resources. You can find the default services for each cloud provider below.