Quickstart

Diom is composed of a set of well integrated infrastructure primitives for backend and data engineers. For more information on each component, please refer to their respective documentation section.

The focus of this page is to help you get started with using the Diom API.

Components

The main concept you need to know when using Diom is component, which is how we call the types of infrastructure primitives in Diom such as cache, kv-store, rate-limiting, and stream.

All components support having multiple entities under them, each addressed with its own key. For example the cache component may have multiple items, the rate-limiter may have multiple different rate-limiters, and the queue component may have many different queues; each with their own key identifying the specific resource.

Diom also supports namespaces, which is a way of having different configurations (such as persistence) for a group of keys within the same component. So you can, for example, have one cache store with a maximum size of 50 GB that is persisted to disk, and a different cache store with a maximum size of 1 GB that is ephemeral. If not set explicitly, the default namespace is used.

Using the SDKs

You can install the SDKs as follows:

npm install diom
// Or
yarn add diom

pip install diom

cargo add diom

go get diom.com/go/diom

implementation "com.svix:diom:0.x.y"

<dependency>
  <groupId>com.svix</groupId>
  <artifactId>diom</artifactId>
  <version>0.x.y</version>
</dependency>

docker run --rm -it \
    -e DIOM_AUTH_TOKEN=${DIOM_AUTH_TOKEN} \
    -e DIOM_SERVER_URL=${DIOM_SERVER_URL} \
    svix/diom-cli

brew install svix/diom/diom-cli

scoop bucket add diom https://github.com/svix/scoop-diom.git
scoop install diom

Example usage (setting a KV key):

import { Diom } from "diom";
 
const diom = new Diom("AUTH_TOKEN", { serverUrl: "https://your-server.example.com" });
const app = await diom.kv.set("key", "value");

from diom import Diom
 
diom = Diom("AUTH_TOKEN", server_url="https://your-server.example.com")
app = diom.kv.create("key", b"value")

use diom::api::{Diom, DiomOptions};
 
let diom = Diom::new("AUTH_TOKEN".to_string(), Some(DiomOptions {
    server_url: Some("https://your-server.example.com".to_string()),
    ..Default::default()
}));
diom
    .kv()
    .set(
        "key",
        b"value",
        None,
    )
    .await?;

import (
	diom "github.com/diom/diom-webhooks"
)
 
diomClient := diom.New("AUTH_TOKEN", &diom.DiomOptions{
    ServerUrl: "https://your-server.example.com",
})
app, err := diomClient.Kv.Set(ctx, "key", b"value", nil)

import com.svix.Diom;
import com.svix.DiomOptions;
 
Diom diom = new Diom("AUTH_TOKEN", new DiomOptions().serverUrl("https://your-server.example.com"));
diom.kv().set("key", b"value")

export DIOM_AUTH_TOKEN='AUTH_TOKEN'
export DIOM_SERVER_URL='https://your-server.example.com'
diom kv set '{ "key": "key", "value": "value" }'

Please refer to each component’s documentation for more information on how to use each one.

Trying it out

To try Diom out either run it locally by following the instructions in the self-hosting section, or try the hosted Diom playground .

Self-hosting

As mentioned above, this page is focused on using Diom, for information on running it, please refer to the self-hosting section of the docs.

Closing words

That’s really all there is to it. All you need is to get an API key, install an SDK, and you can start using Diom!