| GitHub Repository |
This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.spanner for new applications.
Classes
| Class | Description |
|---|---|
| com. |
Finds a server for a request using location-aware routing metadata.
This component is per-database and maintains both recipe and range caches. |
| com. |
Implementation of Cloud Spanner remote calls using Gapic libraries. |
| com. |
Cache for routing information used by location-aware routing. |
| com. |
|
| com. |
|
| com. |
Adds error details to statuses returned by the Cloud Spanner API. TODO(user): Add integration tests to check for error details. |
| com. |
For internal use only. An interceptor provider that provides a list of grpc interceptors for
GapicSpannerRpc to handle logging and error augmentation by intercepting grpc calls. |
| com. |
Represents results from paginated RPCs, i.e., those where up to a maximum number of items is returned from each call and a followup call must be made to fetch more. |
| com. |
|
| com. |
Sortable String Format encoding utilities for Spanner keys.
This class provides methods to encode various data types into a byte format that preserves lexicographic ordering. The encoding supports both increasing and decreasing sort orders. |
| com. |
Represents a key range with start and limit boundaries for routing. |
| com. |
Intercepts all gRPC calls and injects trace context related headers to propagate trace context to Spanner. This class takes reference from OpenTelemetry's JAVA instrumentation library for gRPC. https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/9ecf7965aa455d41ea8cc0761b6c6b6eeb106324/instrumentation/grpc-1.6/library/src/main/java/io/opentelemetry/instrumentation/grpc/v1_6/TracingClientInterceptor.java#L27 |
| com. |
A simple, unsynchronized byte array output stream optimized for key encoding.
Unlike java.io.ByteArrayOutputStream, this class is not thread-safe and does not incur synchronization overhead. This provides better performance for single-threaded key encoding |
Interfaces
| Interface | Description |
|---|---|
| com. |
Represents a Spanner server endpoint for location-aware routing.
Each instance wraps a gRPC ManagedChannel connected to a specific Spanner server. The ChannelEndpointCache creates and caches these instances. |
| com. |
Cache for server connections used in location-aware routing.
Implementations are expected to cache ChannelEndpoint instances such that repeated calls with the same address return the same instance. This allows routing components to |
| com. |
Factory for creating ChannelEndpointCache instances. |
| com. |
Abstracts remote calls to the Cloud Spanner service. Typically end-consumer code will never use this interface; it's main purpose is to abstract the implementation of the public Cloud Spanner API from the underlying transport mechanism. |
| com. |
Consumer for the results produced by a streaming read or query call. |
| com. |
Handle for cancellation of a streaming read or query call. |
Enums
| Enum | Description |
|---|---|
| com. |
Determines how to handle ranges that span multiple splits. |
| com. |
Options passed in SpannerRpc methods to control how an RPC is issued. |