Create a Client

Let’s get your backend code talking to StatelyDB so you can start reading and writing data.

Prerequisites

Creating a Client

When you generated code for your schema, you got a customized client creation function that knows about all of your schema’s types. You can import that function to create a client, and then use that client from your backend code to interact with StatelyDB.

To authenticate your client to the StatelyDB service, you will need both a Client ID and Client Secret. During this preview period you’ll have to get those by contacting [email protected]. These can be passed explicitly when creating a client, or they will be picked up automatically from STATELY_CLIENT_ID and STATELY_CLIENT_SECRET environment variables.

You will also need to specify your Store ID and the region for your store. Both of those are available in the web console, or by running stately whoami with the CLI.


11 collapsed lines
1
package main
2

3
import (
4
  "context"
5

6
  // The StatelyDB SDK
7
  "github.com/StatelyCloud/go-sdk/stately"
8
  // This is the code you generated from schema
9
  "github.com/StatelyCloud/stately/go-sdk-sample/schema"
10
)
11

12
// Create a client for interacting with a Store.
13
func makeClient() stately.Client {
14
  // This uses the generated "NewClient" func in your schema package.
15
  dataClient, err := schema.NewClient(
16
    context.TODO(),
17
    12345, // Store ID
18
    &stately.Options{Region: "us-west-2"},
19
  )
20
  if err != nil {
21
    panic("failed to build StatelyDB client: " + err.Error())
22
  }
23
  return dataClient
24
}

1
# The StatelyDB SDK
2
require 'statelydb'
3
# This is the code you generated from schema
4
require_relative "./schema/stately.item_types"
5

6
client = StatelyDB::Client.new(store_id: 12345, region: "us-west-2")

1
# This is the code you generated from schema
2
from .schema import Client
3

4
client = Client(store_id=12345, region="us-west-2")

1
// This is the code you generated from schema
2
import { createClient } from "./schema/index.js";
3

4
// Create a Data client for interacting with a Store
5
const client = createClient(
6
  12345n, // Store ID
7
  { region: "us-west-2" },
8
);

Providing an explicit Client ID and Client Secret

If you don’t want Client ID and Client Secret to be read from environment variables, you can provide them explicitly:


11 collapsed lines
1
package main
2

3
import (
4
  "context"
5

6
  // The StatelyDB SDK
7
  "github.com/StatelyCloud/go-sdk/stately"
8
  // This is the code you generated from schema
9
  "github.com/StatelyCloud/stately/go-sdk-sample/schema"
10
)
11

12
// Create a client for interacting with a Store.
13
func makeClientWithCredentials() stately.Client {
14
  // Use the generated "NewClient" func in your schema package.
15
  dataClient, err := schema.NewClient(
16
    context.TODO(),
17
    12345, // Store ID
18
    &stately.Options{
19
      Region:       "us-west-2",
20
      ClientID:     "my-client-id",
21
      ClientSecret: "my-client-secret",
22
    },
23
  )
24
  if err != nil {
25
    panic("failed to build StatelyDB client: " + err.Error())
26
  }
27
  return dataClient
28
}

1
# The StatelyDB SDK
2
require 'statelydb'
3
# This is the code you generated from schema
4
require_relative "./schema/stately.item_types"
5

6
client = StatelyDB::Client.new(
7
  store_id: 12345,
8
  region: "us-west-2",
9
  token_provider: StatelyDB::Common::Auth::Auth0TokenProvider.new(
10
    client_id: "my-client-id",
11
    client_secret: "my-client-secret"
12
  )
13
)

1
# The StatelyDB SDK
2
from statelydb import init_server_auth
3

4
# This is the code you generated from schema
5
from .schema import Client
6

7
client = Client(
8
    store_id=12345,
9
    region="us-west-2",
10
    token_provider=init_server_auth(
11
        client_id="my-client-id",
12
        client_secret="my-client-secret",
13
    ),
14
)

1
// The StatelyDB SDK
2
import { initServerAuth } from "@stately-cloud/client";
3
// This is the code you generated from schema
4
import { createClient } from "./schema/index.js";
5

6
// Create a Data client for interacting with a Store
7
const client = createClient(
8
  12345n, // Store ID
9
  {
10
    region: "us-west-2",
11
    authTokenProvider: initServerAuth({
12
      clientID: "my-client-id",
13
      clientSecret: "my-client-secret",
14
    }),
15
  },
16
);