Module data_api 

Enums

AlterTableAddColumnsError

struct for typed errors of method alter_table_add_columns

AnalyzeTableQueryPlanError

struct for typed errors of method analyze_table_query_plan

CountTableRowsError

struct for typed errors of method count_table_rows

CreateTableError

struct for typed errors of method create_table

DeleteFromTableError

struct for typed errors of method delete_from_table

ExplainTableQueryPlanError

struct for typed errors of method explain_table_query_plan

InsertIntoTableError

struct for typed errors of method insert_into_table

MergeInsertIntoTableError

struct for typed errors of method merge_insert_into_table

QueryTableError

struct for typed errors of method query_table

UpdateTableError

struct for typed errors of method update_table

Functions

alter_table_add_columns

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

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.

count_table_rows

Count the number of rows in table id

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 - location: pass through header x-lance-table-location - properties: pass through header x-lance-table-properties

delete_from_table

Delete rows from table id.

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.

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

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.

update_table

Update existing rows in table id.