statelydb

StatelyDB SDK for Ruby

This is the Ruby SDK for StatelyDB. StatelyDB is a document database built on top of DynamoDB. It uses Elastic Schema to allow you to update your data model at any time, with automatic backwards and forwards compatibility.

Getting started:

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 variable
    # STATELY_ACCESS_KEY to read your access key
    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