tiledbsoma.SparseNDArray.create

classmethod SparseNDArray.create(uri: str, *, type: DataType, shape: Sequence[int | None], platform_config: Dict[str, Mapping[str, Any]] | object | None = None, context: SOMATileDBContext | None = None, tiledb_timestamp: int | datetime | None = None) → Self

Creates a SOMA NDArray at the given URI.

Parameters:

  • type – The Arrow type to be stored in the NDArray. If the type is unsupported, an error will be raised.

  • shape –

    The maximum capacity of each dimension, including room for any intended future appends, as a sequence. E.g. (100, 10). All lengths must be in the positive int64 range, or None. It’s necessary to say shape=(None, None) or shape=(None, None, None), as the sequence length determines the number of dimensions N in the N-dimensional array.

    For SparseNDArray only, if a slot is None, then the minimum possible range will be used. This makes a SparseNDArray growable using resize.

  • platform_config – Platform-specific options used to create this array. This may be provided as settings in a dictionary, with options located in the {'tiledb': {'create': ...}} key, or as a TileDBCreateOptions object.

  • tiledb_timestamp – If specified, overrides the default timestamp used to open this object. If unset, uses the timestamp provided by the context.

Returns:

The created NDArray.

Raises:

Lifecycle

Maturing.