python-api.rst

TileDB Python API Reference

Warning

The Python interface to TileDB is still under development and the API is subject to change.

Modules

Typical usage of the Python interface to TileDB will use the top-level module tiledb, e.g.

import tiledb

There is also a submodule libtiledb which contains the necessary bindings to the underlying TileDB native library. Most of the time you will not need to interact with tiledb.libtiledb unless you need native-library specific information, e.g. the version number:

import tiledb
tiledb.libtiledb.version()  # Native TileDB library version number

Exceptions

tiledb.TileDBError

Context

tiledb.Ctx

Config

tiledb.Config

Array Schema

tiledb.ArraySchema

Attribute

tiledb.Attr

Filters

tiledb.FilterList

tiledb.libtiledb.CompressionFilter

tiledb.GzipFilter

tiledb.ZstdFilter

tiledb.LZ4Filter

tiledb.Bzip2Filter

tiledb.RleFilter

tiledb.DoubleDeltaFilter

tiledb.BitShuffleFilter

tiledb.ByteShuffleFilter

tiledb.BitWidthReductionFilter

tiledb.PositiveDeltaFilter

Dimension

tiledb.Dim

Domain

tiledb.Domain

Array

tiledb.libtiledb.Array

tiledb.consolidate

Dense Array

tiledb.DenseArray

__getitem__(selection)

__setitem__(selection, value)

Sparse Array

tiledb.SparseArray

__getitem__(selection)

__setitem__(selection, value)

Object Management

tiledb.group_create

tiledb.object_type

tiledb.remove

tiledb.move

tiledb.ls

tiledb.walk

VFS

tiledb.VFS

Version

tiledb.libtiledb.version

Statistics

tiledb.stats_enable

tiledb.stats_disable

tiledb.stats_reset

tiledb.stats_dump