Module metadata_api 

Enums

AlterTableAlterColumnsError

struct for typed errors of method alter_table_alter_columns

AlterTableDropColumnsError

struct for typed errors of method alter_table_drop_columns

AlterTransactionError

struct for typed errors of method alter_transaction

CreateEmptyTableError

struct for typed errors of method create_empty_table

CreateNamespaceError

struct for typed errors of method create_namespace

CreateTableIndexError

struct for typed errors of method create_table_index

CreateTableTagError

struct for typed errors of method create_table_tag

DeleteTableTagError

struct for typed errors of method delete_table_tag

DeregisterTableError

struct for typed errors of method deregister_table

DescribeNamespaceError

struct for typed errors of method describe_namespace

DescribeTableError

struct for typed errors of method describe_table

DescribeTableIndexStatsError

struct for typed errors of method describe_table_index_stats

DescribeTransactionError

struct for typed errors of method describe_transaction

DropNamespaceError

struct for typed errors of method drop_namespace

DropTableError

struct for typed errors of method drop_table

DropTableIndexError

struct for typed errors of method drop_table_index

GetTableStatsError

struct for typed errors of method get_table_stats

GetTableTagVersionError

struct for typed errors of method get_table_tag_version

ListNamespacesError

struct for typed errors of method list_namespaces

ListTableIndicesError

struct for typed errors of method list_table_indices

ListTableTagsError

struct for typed errors of method list_table_tags

ListTableVersionsError

struct for typed errors of method list_table_versions

ListTablesError

struct for typed errors of method list_tables

NamespaceExistsError

struct for typed errors of method namespace_exists

RegisterTableError

struct for typed errors of method register_table

RestoreTableError

struct for typed errors of method restore_table

TableExistsError

struct for typed errors of method table_exists

UpdateTableTagError

struct for typed errors of method update_table_tag

Functions

alter_table_alter_columns

Modify existing columns in table id, such as renaming or changing data types.

alter_table_drop_columns

Remove specified columns from table id.

alter_transaction

Alter a transaction with a list of actions such as setting status or properties. The server should either succeed and apply all actions, or fail and apply no action.

create_empty_table

Create an empty table with the given name without touching storage. This is a metadata-only operation that records the table existence and sets up aspects like access control. For DirectoryNamespace implementation, this creates a .lance-reserved file in the table directory to mark the table’s existence without creating actual Lance data files.

create_namespace

Create new namespace id. During the creation process, the implementation may modify user-provided properties, such as adding additional properties like created_at to user-provided properties, omitting any specific property, or performing actions based on any property value.

create_table_index

Create an index on a table column for faster search operations. Supports vector indexes (IVF_FLAT, IVF_HNSW_SQ, IVF_PQ, etc.) and scalar indexes (BTREE, BITMAP, FTS, etc.). Index creation is handled asynchronously. Use the ListTableIndices and DescribeTableIndexStats operations to monitor index creation progress.

create_table_tag

Create a new tag for table id that points to a specific version.

delete_table_tag

Delete an existing tag from table id.

deregister_table

Deregister table id from its namespace.

describe_namespace

Describe the detailed information for namespace id.

describe_table

Describe the detailed information for table id.

describe_table_index_stats

Get statistics for a specific index on a table. Returns information about the index type, distance type (for vector indices), and row counts.

describe_transaction

Return a detailed information for a given transaction

drop_namespace

Drop namespace id from its parent namespace.

drop_table

Drop table id and delete its data.

drop_table_index

Drop the specified index from table id.

get_table_stats

Get statistics for table id, including row counts, data sizes, and column statistics.

get_table_tag_version

Get the version number that a specific tag points to for table id.

list_namespaces

List all child namespace names of the parent namespace id. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the ListNamespacesRequest information in the following way: - id: pass through path parameter of the same name - page_token: pass through query parameter of the same name - limit: pass through query parameter of the same name

list_table_indices

List all indices created on a table. Returns information about each index including name, columns, status, and UUID.

list_table_tags

List all tags that have been created for table id. Returns a map of tag names to their corresponding version numbers and metadata. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the ListTableTagsRequest information in the following way: - id: pass through path parameter of the same name - page_token: pass through query parameter of the same name - limit: pass through query parameter of the same name

list_table_versions

List all versions (commits) of table id with their metadata.

list_tables

List all child table names of the parent namespace id. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the ListTablesRequest information in the following way: - id: pass through path parameter of the same name - page_token: pass through query parameter of the same name - limit: pass through query parameter of the same name

namespace_exists

Check if namespace id exists. This operation must behave exactly like the DescribeNamespace API, except it does not contain a response body.

register_table

Register an existing table at a given storage location as id.

restore_table

Restore table id to a specific version.

table_exists

Check if table id exists. This operation should behave exactly like DescribeTable, except it does not contain a response body. For DirectoryNamespace implementation, a table exists if either: - The table has Lance data versions (regular table created with CreateTable) - A .lance-reserved file exists in the table directory (empty table created with CreateEmptyTable)

update_table_tag

Update an existing tag for table id to point to a different version.