cf.create_group_from_xarray
cf.create_group_from_xarray(dataset, group_uri, *, config=None, ctx=None, append=False, encoding=None, unlimited_dims=None, skip_vars=None, copy_group_metadata=True, copy_variable_metadata=True)
Creates a TileDB group and arrays from an xarray dataset.
Optionally copies metadata as well.
Parameters
Name | Type | Description | Default |
---|---|---|---|
dataset |
The xarray Dataset to write. | required | |
group_uri |
The URI to the TileDB group to create or append to. | required | |
config |
typing.Optional[tiledb.tiledb.Config] | A TileDB config object to use for TileDB objects. | None |
ctx |
typing.Optional[tiledb.tiledb.Ctx] | A TileDB context object to use for TileDB operations. | None |
append |
bool | If true, add arrays to an existing TileDB Group. Otherwise, create a new TileDB group to add arrays to. | False |
encoding |
typing.Optional[typing.Mapping[str, typing.Any]] | A nested dictionary with variable names as keys and dictionaries of TileDB specific encodings as values. | None |
unlimited_dims |
typing.Optional[typing.Iterable[str]] | Set of dimensions to use the maximum dimension size for. Only used for variables in the dataset that do not have max_size encoding provided. |
None |
skip_vars |
typing.Optional[typing.Set[str]] | A set of names of variables not to add to the TileDB group. | None |
copy_group_metadata |
bool | If true, copy xarray dataset metadata to the TileDB group. | True |
copy_variable_metadata |
bool | If true, copy xarray variable metadata to the TileDB arrays as TileDB attribute metadata. | True |