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

DomainMethodsFlagship (with example)Clients
Query & SQL154FlightClient, RelataClient
Search & Retrieval32RelataClient, SearchClient
Vectors & Embeddings122RelataClient, VectorClient
Ingest102IngestClient, RelataClient
Objects & CRUD61ObjectClient
Types & Ontology142RelataClient
Identity & Entity Lifecycle134IdentityClient, RelataClient
Graph Algorithms & Intelligence236RelataClient
Governance & Compliance215GovernanceClient
Agent Memory163Memory, RelataClient
MCP & Agent-to-Agent711McpClient
Streaming & Transparency Log81LogClient, StreamingClient
Audit & Reporting102AuditClient, RelataClient
Admin, Ops & Multi-Tenancy463BackupClient, RelataClient, SystemClient, TenantAdminClient, TokenClient
Total26842—

Cross-SDK spelling conventions

ConceptPythonTypeScriptGo
method namingsnake_casecamelCasePascalCase
async (Python only)a-prefix (aquery)async keywordctx context.Context first
typed sub-clientIngestClient.from_client(c)c.ingestc.Ingest

See also: SDK overview for install + the parity matrix, and the per-language quickstarts (Python · TypeScript · Go).