tiledbsoma.TileDBCreateOptions¶

class tiledbsoma.TileDBCreateOptions(*, dataframe_dim_zstd_level: int = 3, sparse_nd_array_dim_zstd_level: int = 3, dense_nd_array_dim_zstd_level: int = 3, write_X_chunked: bool = True, goal_chunk_nnz: int = 100000000, remote_cap_nbytes: int = 2400000000, capacity: int = 100000, offsets_filters: Iterable[str | Mapping[str, object]] = ('DoubleDeltaFilter', 'BitWidthReductionFilter', 'ZstdFilter'), validity_filters: Iterable[str | Mapping[str, object]] | None = None, allows_duplicates: bool = False, tile_order: str | None = None, cell_order: str | None = None, dims: Mapping[str, _DictColumnSpec] = NOTHING, attrs: Mapping[str, _DictColumnSpec] = NOTHING)¶

Tuning options used when creating new SOMA arrays.

The attribute names of this object are identical to the keys expected in the cross-platform platform_config dict under the tiledb.create subkey, with values also accepted in that format (i.e., we create TileDBCreateOptions from a tiledb.create by directly calling TileDBCreateOptions(**tiledb_create_dict)).

__init__(*, dataframe_dim_zstd_level: int = 3, sparse_nd_array_dim_zstd_level: int = 3, dense_nd_array_dim_zstd_level: int = 3, write_X_chunked: bool = True, goal_chunk_nnz: int = 100000000, remote_cap_nbytes: int = 2400000000, capacity: int = 100000, offsets_filters: Iterable[str | Mapping[str, object]] = ('DoubleDeltaFilter', 'BitWidthReductionFilter', 'ZstdFilter'), validity_filters: Iterable[str | Mapping[str, object]] | None = None, allows_duplicates: bool = False, tile_order: str | None = None, cell_order: str | None = None, dims: Mapping[str, _DictColumnSpec] = NOTHING, attrs: Mapping[str, _DictColumnSpec] = NOTHING) → None¶: Method generated by attrs for class TileDBCreateOptions.

Methods

`__init__`(*[, dataframe_dim_zstd_level, ...])	Method generated by attrs for class TileDBCreateOptions.
`cell_tile_orders`()	Returns the cell and tile orders that should be used.
`dim_tile`(dim_name[, default])	Returns the tile extent for the given dimension.
`from_platform_config`([platform_config])	Creates the object from a value passed in `platform_config`.

Attributes

`dataframe_dim_zstd_level`
`sparse_nd_array_dim_zstd_level`
`dense_nd_array_dim_zstd_level`
`write_X_chunked`
`goal_chunk_nnz`
`remote_cap_nbytes`
`capacity`
`offsets_filters`
`validity_filters`
`allows_duplicates`
`tile_order`
`cell_order`
`dims`
`attrs`