Module table_api 

Enums

AlterTableAddColumnsError

struct for typed errors of method alter_table_add_columns

AlterTableAlterColumnsError

struct for typed errors of method alter_table_alter_columns

AlterTableDropColumnsError

struct for typed errors of method alter_table_drop_columns

AnalyzeTableQueryPlanError

struct for typed errors of method analyze_table_query_plan

CountTableRowsError

struct for typed errors of method count_table_rows

CreateEmptyTableError

struct for typed errors of method create_empty_table

CreateTableError

struct for typed errors of method create_table

CreateTableIndexError

struct for typed errors of method create_table_index

CreateTableScalarIndexError

struct for typed errors of method create_table_scalar_index

CreateTableTagError

struct for typed errors of method create_table_tag

DeclareTableError

struct for typed errors of method declare_table

DeleteFromTableError

struct for typed errors of method delete_from_table

DeleteTableTagError

struct for typed errors of method delete_table_tag

DeregisterTableError

struct for typed errors of method deregister_table

DescribeTableError

struct for typed errors of method describe_table

DescribeTableIndexStatsError

struct for typed errors of method describe_table_index_stats

DropTableError

struct for typed errors of method drop_table

DropTableIndexError

struct for typed errors of method drop_table_index

ExplainTableQueryPlanError

struct for typed errors of method explain_table_query_plan

GetTableStatsError

struct for typed errors of method get_table_stats

GetTableTagVersionError

struct for typed errors of method get_table_tag_version

InsertIntoTableError

struct for typed errors of method insert_into_table

ListAllTablesError

struct for typed errors of method list_all_tables

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

MergeInsertIntoTableError

struct for typed errors of method merge_insert_into_table

QueryTableError

struct for typed errors of method query_table

RegisterTableError

struct for typed errors of method register_table

RenameTableError

struct for typed errors of method rename_table

RestoreTableError

struct for typed errors of method restore_table

TableExistsError

struct for typed errors of method table_exists

UpdateTableError

struct for typed errors of method update_table

UpdateTableSchemaMetadataError

struct for typed errors of method update_table_schema_metadata

UpdateTableTagError

struct for typed errors of method update_table_tag

Functions

alter_table_add_columns

Add new columns to table id using SQL expressions or default values.

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.

analyze_table_query_plan

Analyze the query execution plan for a query against table id. Returns detailed statistics and analysis of the query execution plan. REST NAMESPACE ONLY REST namespace returns the response as a plain string instead of the AnalyzeTableQueryPlanResponse JSON object.

count_table_rows

Count the number of rows in table id REST NAMESPACE ONLY REST namespace returns the response as a plain integer instead of the CountTableRowsResponse JSON object.

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. Deprecated: Use DeclareTable instead.

create_table

Create table id in the namespace with the given data in Arrow IPC stream. The schema of the Arrow IPC stream is used as the table schema. If the stream is empty, the API creates a new empty table. REST NAMESPACE ONLY REST namespace uses Arrow IPC stream as the request body. It passes in the CreateTableRequest information in the following way: - id: pass through path parameter of the same name - mode: pass through query parameter of the same name

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_scalar_index

Create a scalar index on a table column for faster filtering operations. Supports scalar indexes (BTREE, BITMAP, LABEL_LIST, FTS, etc.). This is an alias for CreateTableIndex specifically for scalar indexes. 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.

declare_table

Declare a 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.

delete_from_table

Delete rows from table id.

delete_table_tag

Delete an existing tag from table id.

deregister_table

Deregister table id from its namespace.

describe_table

Describe the detailed information for table id. REST NAMESPACE ONLY REST namespace passes with_table_uri and load_detailed_metadata as query parameters instead of in the request body.

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.

drop_table

Drop table id and delete its data. REST NAMESPACE ONLY REST namespace does not use a request body for this operation. The DropTableRequest information is passed in the following way: - id: pass through path parameter of the same name

drop_table_index

Drop the specified index from table id. REST NAMESPACE ONLY REST namespace does not use a request body for this operation. The DropTableIndexRequest information is passed in the following way: - id: pass through path parameter of the same name - index_name: pass through path parameter of the same name

explain_table_query_plan

Get the query execution plan for a query against table id. Returns a human-readable explanation of how the query will be executed. REST NAMESPACE ONLY REST namespace returns the response as a plain string instead of the ExplainTableQueryPlanResponse JSON object.

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.

insert_into_table

Insert new records into table id. REST NAMESPACE ONLY REST namespace uses Arrow IPC stream as the request body. It passes in the InsertIntoTableRequest information in the following way: - id: pass through path parameter of the same name - mode: pass through query parameter of the same name

list_all_tables

List all tables across all namespaces. REST NAMESPACE ONLY REST namespace uses GET to perform this operation without a request body. It passes in the ListAllTablesRequest information in the following way: - page_token: pass through query parameter of the same name - limit: pass through query parameter of the same name - delimiter: 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 does not use a request body for this operation. The ListTableTagsRequest information is passed 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. REST NAMESPACE ONLY REST namespace does not use a request body for this operation. The ListTableVersionsRequest information is passed 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_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

merge_insert_into_table

Performs a merge insert (upsert) operation on table id. This operation updates existing rows based on a matching column and inserts new rows that don’t match. It returns the number of rows inserted and updated. REST NAMESPACE ONLY REST namespace uses Arrow IPC stream as the request body. It passes in the MergeInsertIntoTableRequest information in the following way: - id: pass through path parameter of the same name - on: pass through query parameter of the same name - when_matched_update_all: pass through query parameter of the same name - when_matched_update_all_filt: pass through query parameter of the same name - when_not_matched_insert_all: pass through query parameter of the same name - when_not_matched_by_source_delete: pass through query parameter of the same name - when_not_matched_by_source_delete_filt: pass through query parameter of the same name

query_table

Query table id with vector search, full text search and optional SQL filtering. Returns results in Arrow IPC file or stream format. REST NAMESPACE ONLY REST namespace returns the response as Arrow IPC file binary data instead of the QueryTableResponse JSON object.

register_table

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

rename_table

Rename table id to a new name.

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 (declared table created with DeclareTable)

update_table

Update existing rows in table id.

update_table_schema_metadata

Replace the schema metadata for table id with the provided key-value pairs. REST NAMESPACE ONLY REST namespace uses a direct object (map of string to string) as both request and response body instead of the wrapped UpdateTableSchemaMetadataRequest and UpdateTableSchemaMetadataResponse.

update_table_tag

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