Quickstart

Provision a database, connect through the gateway, and verify your first TigerBeetle operation.

This quickstart follows the product flow implemented in the web app today.

1. Provision a database

Create a database from the Parix dashboard:

choose a provider-backed region
choose cluster topology and size
wait for the database profile to become active

Current lifecycle workflows are handled by the control plane. The product stores the requested profile first, then converges provider runtime state through workflows.

2. Open the connect flow

The current connect page exposes:

a gateway URL for the database
TigerBeetle client installation examples
a short verification example

The connect flow is documented in more detail under Connecting to cluster.

3. Install a client library

The dashboard currently shows examples for official TigerBeetle clients such as Go, Java, Node.js, .NET, and Python.

For example, Node.js:

npm install tigerbeetle-node

4. Configure the gateway address

Use the gateway URL shown in the dashboard as your address.

Example Go client setup from the current UI pattern:

client, err := tb.NewClient(tb.ClientConfig{
  ClusterID: [16]byte{},
  Addresses: []string{"<gateway-url>"},
})

Parix keeps the database behind a gateway path rather than exposing raw TigerBeetle infrastructure directly.

5. Verify connectivity

Run a simple lookup operation to confirm the connection works:

accounts, err := client.LookupAccounts([]tb.ID{})
if err != nil {
  log.Fatal("connection failed:", err)
}
fmt.Println("Connected successfully!")

If the request returns without an error, your application can reach the managed cluster.