statelydb

StatelyDB SDK for Ruby

This is the Ruby SDK for StatelyDB.

Getting started:

Disclaimer:

We're still in an invite-only preview mode - if you're interested, please reach out to [e-mail].

When you join the preview program, we'll set you up with a few bits of information:

1. STATELY_CLIENT_ID - a client identifier so we know what client you are.
2. STATELY_CLIENT_SECRET - a sensitive secret that lets your applications authenticate with the API.
3. A store ID that identifies which store in your organization you're using.
4. Access to our in-depth Getting Started Guide.

Begin by following our Getting Started Guide which will help you define, generate, and publish a DB schema so that it can be used.

Install the SDK

gem install statelydb

Usage:

Create an authenticated client, then import your item types from your generated schema module and use the client!

require_relative 'schema/stately'

def put_my_item
    # Create a client. This will use the environment variables
    # STATELY_CLIENT_ID and STATELY_CLIENT_SECRET for your client.
    client = StatelyDB::Client.new(store_id: <my-store-id>)

    # Instantiate an item from your schema
    item = StatelyDB::Types::MyItem.new(name: "Jane Doe")

    # put and get the item!
    put_result = client.put(item)
    get_result = client.get(StatelyDB::KeyPath.with("name", "Jane Doe"))
    puts put_result == get_result # true

---