Skip to main content

Interface and architecture map

Use this map to move from a user-facing interface to its owning contract and the mechanisms underneath it. The interface chooser compares entry points; the component directory identifies the libraries and executables that implement them. Each linked reference states its supported operations, types, configuration and failure behavior.

Public entry pointsโ€‹

Start with data, computation and policies to choose the data representation, computation lifetime and observations you need. The interfaces below expose different portions of that lifecycle through shared owners.

InterfaceUsage and limitsExact owner or descriptionMechanisms
Local supervisor and consoleCLI, configuration, consoleInstallation, configurationExecution and recovery, service sessions
Native SQL HTTP/TLS and Unix sessionsSQL sessions, statementsSQL session contractService interfaces, query engine
PostgreSQL and MySQLDatabase protocols, local loginWire adaptationService interfaces
Application language SDKsSDKs, caller semantics, examplesStation ABI, native protocolClient/framework boundary
Signed native HTTPNative protocol, permissionsHTTP carriage, native operationsSystem model, execution
Original-subject Table mediationTables, Table serviceDeclarative catalog, messagesState model, query engine
Application HTTP publicationServing, OpenAPIServing contractService interfaces
SSE and WebSocketReactive sessions, AsyncAPIReactive contractService interfaces
Board and operator inspectionBoard guide, Board OpenAPIBoard schemaObserved state and authority
Arrow IPC/C, Flight SQL and ADBCArrow, Flight compatibilityFlight contract, query contractQuery engine
Outbound HTTP, gRPC and FlightConnectorsHTTP effects, gRPC effects, Flight effectsEffect lifecycle

SQL HTTP, signed native HTTP, application Serving and Board are different interfaces with different authentication and ownership. A native SQL session handle does not authenticate a Board or Serving request. A transport's ability to encode a type does not establish query execution support for that type.

Runtime foundationsโ€‹

SubjectCurrent behaviorTechnical account
Ownership, fencing, process turns and deliveryProcesses, streamsSystem model, execution model
Grants, credentials and resource lifetimeSecurity, retentionExecution model, state model
KV, Tables, Documents and associationsState, Tables, DocumentsState model
Station calls, supervision and host boundariesStation, callersClient/framework boundary
Planning, snapshots, typed batches and result publicationQueries, SQL types, ArrowQuery engine
Page storage, immutable bulk data, concurrency and cleanupStorage, retentionStorage runtime
Installation, replacement and physical deploymentApplications, deploymentExecution model
Logs, metrics, diagnostics and measured costObservability, performance, benchmarksVerification method, storage runtime

Compatibility and evidenceโ€‹

Contract downloads provides machine-readable descriptions from their authoritative sources. Versioning explains why a v1 name alone does not establish compatibility between builds. Verification limits separates current guarantees from the scope of executed checks; the repository's proof ledger owns those execution records.

The handbook documents the checked-out source revision. References and guides describe use; Internals explains models, invariants, tradeoffs and evidence. Neither a published page nor a successful documentation build certifies a new runtime profile. Component API guides remain beside their implementations and are included or linked from these owners.