API Reference¶
The Multicloud DB SDK publishes Javadoc for the public API surface.
Core Package: com.multiclouddb.api¶
The multiclouddb-api module is the only compile-time dependency your
application needs. All types in com.multiclouddb.api.* are the portable
contract.
Key Types¶
| Type | Description |
|---|---|
MulticloudDbClient |
The main client interface - CRUD, query, provisioning, and capabilities |
MulticloudDbClientFactory |
Creates a client by discovering providers via ServiceLoader |
MulticloudDbClientConfig |
Builder-pattern configuration for provider, connection, and auth |
ResourceAddress |
A (database, collection) pair targeting a container/table |
MulticloudDbKey |
A (partitionKey, sortKey) identity for every document |
QueryRequest |
Query input with expression, parameters, pagination, and partition scoping |
QueryPage |
Query result: items, continuation token, and diagnostics |
DocumentResult |
Read result: document payload and optional metadata |
DocumentMetadata |
Write timestamps, TTL expiry, and version/ETag |
CapabilitySet |
Runtime introspection of supported provider capabilities |
MulticloudDbException |
Structured error with portable error category |
OperationOptions |
Per-operation timeout, TTL, and metadata controls |
OperationDiagnostics |
Latency, request charge, request ID, and item count |
Query Expression Types¶
| Type | Description |
|---|---|
Expression |
AST node interface for parsed query expressions |
ExpressionParser |
Parses portable expression strings into an AST |
ExpressionValidator |
Validates parameter bindings and function signatures |
ExpressionTranslator |
SPI - translates AST to provider-native query syntax |
TranslatedQuery |
Translation result: query string + bound parameters |
Building Javadoc Locally¶
Generate the full API documentation with:
The generated HTML is written to:
Open this file in a browser to explore the full Javadoc with cross-references and search.
SPI Package: com.multiclouddb.spi¶
Provider implementors use the SPI interfaces - application code should not import from this package.
| Type | Description |
|---|---|
MulticloudDbProviderAdapter |
Factory SPI - creates a provider client from config |
MulticloudDbProviderClient |
Implementation SPI - CRUD + query + provisioning |
SdkUserAgent |
Builds the canonical user-agent header token |