tiledbsoma.SOMATileDBContext

class tiledbsoma.SOMATileDBContext(tiledb_config: dict[str, str | float] | None = None, tiledb_ctx: Any | None = None, timestamp: int | datetime | None = None, threadpool: ThreadPoolExecutor | None = None)

Maintains TileDB-specific context for TileDB-SOMA objects. This context can be shared across multiple objects, including having a child object inherit it from its parent.

Treat this as immutable. Only code internal to the _soma_tiledb_context module should be modifying this. Use the replace method to construct a new SOMATileDBContext with new values.

Lifecycle

Maturing.

__init__(tiledb_config: dict[str, str | float] | None = None, tiledb_ctx: Any | None = None, timestamp: int | datetime | None = None, threadpool: ThreadPoolExecutor | None = None) → None

Initializes a new SOMATileDBContext.

Either tiledb_config or tiledb_ctx may be provided, or both may be left at their default.

If a tiledb_config is provided (in the form of a dict), it is used to construct a new SOMAContext.

If a `tiledb_ctx` is provided, then it uses the configuration options to construct a new SOMAContext. Note that SOMAContext will create a new Context object. The tiledb_ctx option is only available if the tiledb module is installed; otherwise, it will throw a ``ModuleNotFoundError.

If neither are provided, this will use a single shared SOMAContext instantiated upon first use.

Parameters:

• tiledb_config – A set of TileDB configuration options to use, overriding the default configuration.

• tiledb_ctx – A TileDB Context where the set of TileDB configuration options are used to override the default configuration.

• timestamp –

  The default timestamp for operations on SOMA objects, provided either as a datetime.datetime or a number of milliseconds since the Unix epoch.

  WARNING: This should not be set unless you are absolutely sure you want to use the same timestamp across multiple operations. If multiple writes to the same object are performed at the same timestamp, they have no defined order. In almost all cases, it is better to pass a timestamp to a single open call, or to simply use the default behavior.

  This is used when a timestamp is not provided to an open operation.

  None, the default, sets the timestamp on each root open operation. That is, if you open a collection, and access individual members of the collection through indexing or add_new, the timestamp of all of those operations will be that of the time you called open.

  If a value is passed, that timestamp is used as the timestamp to record all operations.

  Set to 0xFFFFFFFFFFFFFFFF (UINT64_MAX) to get the absolute latest revision (i.e., including changes that occur “after” the current wall time) as of when each object is opened.

• threadpool – A threadpool to use for concurrent operations. If not provided, a new ThreadPoolExecutor will be created with default settings.

Methods

__init__([tiledb_config, tiledb_ctx, ...])	Initializes a new SOMATileDBContext.
replace(*[, tiledb_config, tiledb_ctx, ...])	Create a copy of the context, merging changes.

Attributes

native_context	The C++ SOMAContext for this SOMA context.
tiledb_config	The TileDB configuration dictionary for this SOMA context.
timestamp	The default timestamp for SOMA operations, or None if not provided.
timestamp_ms	The default timestamp for SOMA operations, as milliseconds since the Unix epoch, or None if not provided.
threadpool	User specified threadpool.