SDK Method Reference
Relata DB 3.0
SDK method names are mostly unchanged in 3.0, but the SDKs call the new
/v1 routes and some wrappers are removed or reshaped (tenant administration, cluster operations, webhooks, dedup tokens, media embedding). See the SDK changes. Python, TypeScript and Go are the only supported SDKs.RelataDB is a governed temporal knowledge database — policy, provenance, and bi-temporal history live in the query path, not bolted on. The three consumer SDKs (Python, TypeScript, Go) expose one shape over that surface: every call declares a purpose, runs through ACL + cell-masking + audit, and writes bi-temporal rows with provenance.
This reference indexes every public method, grouped by domain. Each entry shows the signature with keyword-only tunable defaults (e.g. damping=None, top_k=5), the three SDK spellings, and — for the flagship methods customers actually tune — a hand-written When to use note and a runnable example.
Note
Source of truth: the SDK source itself. This page is ported from RelataDB's generated
sdk-methods.md and refreshed manually when the surface changes — re-run scripts/gen_sdk_methods_docs.py in this repo.Coverage by domain
| Domain | Methods | Flagship (with example) | Clients |
|---|---|---|---|
| Query & SQL | 15 | 4 | FlightClient, RelataClient |
| Search & Retrieval | 3 | 2 | RelataClient, SearchClient |
| Vectors & Embeddings | 12 | 2 | RelataClient, VectorClient |
| Ingest | 10 | 2 | IngestClient, RelataClient |
| Objects & CRUD | 6 | 1 | ObjectClient |
| Types & Ontology | 14 | 2 | RelataClient |
| Identity & Entity Lifecycle | 13 | 4 | IdentityClient, RelataClient |
| Graph Algorithms & Intelligence | 23 | 6 | RelataClient |
| Governance & Compliance | 21 | 5 | GovernanceClient |
| Agent Memory | 16 | 3 | Memory, RelataClient |
| MCP & Agent-to-Agent | 71 | 1 | McpClient |
| Streaming & Transparency Log | 8 | 1 | LogClient, StreamingClient |
| Audit & Reporting | 10 | 2 | AuditClient, RelataClient |
| Admin, Ops & Multi-Tenancy | 46 | 3 | BackupClient, RelataClient, SystemClient, TenantAdminClient, TokenClient |
| Total | 268 | 42 | — |
Cross-SDK spelling conventions
| Concept | Python | TypeScript | Go |
|---|---|---|---|
| method naming | snake_case | camelCase | PascalCase |
| async (Python only) | a-prefix (aquery) | async keyword | ctx context.Context first |
| typed sub-client | IngestClient.from_client(c) | c.ingest | c.Ingest |
See also: SDK overview for install + the parity matrix, and the per-language quickstarts (Python · TypeScript · Go).