Key-Value Storage Layer¶

Most TensorStore drivers access the underlying storage for array data through a key-value store layer that supports a variety of underlying storage systems, such as the local filesystem and cloud storage systems, through different drivers.

json KvStore : object¶

Key-value store specification.

This describes the common properties supported by all key-value stores. Refer to the driver documentation for the supported driver identifiers and driver-specific properties.

Subtypes:¶

• KvStoreAdapter — Key-value store adapter that adapts a single base key-value store.

• kvstore/file — Read/write access to the local filesystem.

• kvstore/gcs — Read/write access to Google Cloud Storage (GCS).

• kvstore/http — Read-only access to arbitrary HTTP servers.

• kvstore/kvstack — Stack (overlay) driver for key value store mapping.

• kvstore/memory — Read/write, non-persistent in-memory storage.

• kvstore/s3 — Read/write access to Amazon S3-compatible object stores.

• kvstore/tsgrpc_kvstore — Read/write key-value store using the tensorstore-specific gRPC protocol.

Required members:¶

driver : string¶

Key-value store driver identifier

Optional members:¶

path : string¶

Key prefix within the key-value store.

If the prefix is intended to correspond to a Unix-style directory path, it should end with "/".

context : Context¶

Specifies context resources that augment/override the parent context.

json KvStoreUrl : string¶

URL representation of a key-value store.

In addition to the JSON object representation, a key-value store may be specified more concisely by a URL pipeline consisting of one or more |-separated components.

The first component specifies a root key-value store (such as file) that directly accesses storage. Subsequent components, if any, must be key-value store adapters such as zip or ocdbt.

Warning

The URL representation of a key-value store specification may exclude certain parameters, such as concurrency limits.

Subtypes:¶

• KvStoreUrl/file — file:// KvStore URL scheme

• KvStoreUrl/gs — gs:// KvStore URL scheme

• KvStoreUrl/http — http:// and https:// KvStore URL scheme

• KvStoreUrl/memory — memory:// KvStore URL scheme

• KvStoreUrl/ocdbt — ocdbt: KvStore URL scheme

• KvStoreUrl/s3 — s3:// KvStore URL scheme

• KvStoreUrl/zip — zip: KvStore URL scheme

Root drivers¶

Adapters¶

json KvStoreAdapter : object¶

Key-value store adapter that adapts a single base key-value store.

Extends:¶

• KvStore — Key-value store specification.

Subtypes:¶

• kvstore/neuroglancer_uint64_sharded — Read/write adapter for the Neuroglancer Precomputed sharded format.

• kvstore/ocdbt — Read/write adapter for the OCDBT format.

• kvstore/zarr3_sharding_indexed — Read/write adapter for the zarr v3 sharded_indexed format.

• kvstore/zip — Read-only adapter for the ZIP archive format.

Required members:¶

driver : string¶

Key-value store driver identifier

base : KvStore | KvStoreUrl¶

Base key-value store to adapt.

Optional members:¶

path : string¶

Key prefix within the key-value store.

If the prefix is intended to correspond to a Unix-style directory path, it should end with "/".

context : Context¶

Specifies context resources that augment/override the parent context.