SDKs
Use a ScopeDB SDK from a supported backend runtime. SDKs configure authentication, follow statement execution to a terminal result, browse the catalog, convert result cells into language-native values, and provide bounded streaming writes.
These SDKs are pre-release. The pages below describe current behavior only; pin your dependency version and upgrade intentionally.
Choose an SDK
| Runtime | Package | Start here |
|---|---|---|
| Node.js 20 or later | scopedb | Node.js SDK |
| Go 1.24 or later | github.com/scopedb/scopedb-sdk/go | Go SDK |
| Rust 1.85 or later | scopedb-client | Rust SDK |
Use the HTTP API from other backend runtimes or when you need direct control over requests and responses.
Common workflow
- Copy the ScopeDB API address and create an API key by following Connect an application.
- Create a client in a trusted server-side process.
- Use the catalog to discover or describe an existing destination table.
- Call the SDK's query path to execute ScopeQL and convert the result into the representation expected by your application.
- For typed rows that already match a table, use the SDK's append stream for bounded batching and explicit flush or shutdown barriers.
Use each language page for its documented workflows and its package reference or repository examples for the complete public surface. For the underlying statement lifecycle, error contract, and retry guidance, use the HTTP API.
SDK documentation covers client behavior, not the ScopeQL language. Start with the ScopeQL quickstart, use Query data for common query workflows, and use the Reference for exact syntax.