API Reference

Client Configuration

Details about configuring and logging in with the client.

client	TileDB client and supporting methods, such as login()
config	TileDB client session configuration
tokens	Access to API tokens.

Modalities and Assets

Organize and structure your data.

assets	An Asset is an item in the TileDB Catalog.
array	Register, search, and manage arrays with TileDB.
files	TileDB File Assets
folders	TileDB folders.
dashboard

SOMA

soma.ingest
soma.mapper

VCF

vcf.allele_frequency
vcf.ingestion
vcf.query
vcf.split	Split samples from multi-sample VCF.
vcf.utils

Biomedical Imaging

bioimg.exportation
bioimg.ingestion

Tables and SQL

sql.tiledb_connection
sql.tiledb_cursor

UDFs

Run arbitrary or array-specific code.

udf

Task Graphs

Ingest and analyze data that is too large for a single computer.

compute.delayed
dag.dag	Directed acyclic graphs as TileDB task graphs.
dag.mode
dag.visualization
taskgraphs.builder	The code to build task graphs for later registration and execution.
taskgraphs.executor	Generic interfaces for task graph executors.
taskgraphs.registration
taskgraphs.types	User-facing types used in task graphs.

Workflows

TODO

workflows.workflow

Functions for working with TileDB workflows.

Geospatial

geospatial.ingestion

Teamspaces

Everything related to working with teamspaces and teamspace membership.

teamspaces

TileDB Teamspaces

Workspaces

Everything related to working with workspaces and workspace membership.

workspaces

TileDB workspaces and workspace users.

Monitoring

Monitor tasks and get task details.

tasks

Access to information about TileDB tasks.

Storage Settings

Storage settings for your workspaces and teamspaces.

credentials	TileDB Credentials.
storagesettings	TileDB Storage Settings.

Utilities

Different utility functions and methods for managing your TileDB deployment.

utilities.consolidate
utilities.profiler
pager	Pagination.
versions	Retrieve TileDB Server version information.