API Reference
- SDKs
- Overview
- GETList all tables
- POSTRegister a table to a namespace
- POSTDescribe information of a table
- POSTCheck if a table exists
- POSTDrop a table
- POSTDeregister a table
- POSTRestore table to a specific version
- POSTRename a table
- POSTUpdate table schema metadata
- POSTList all versions of a table
- POSTCreate a new table version
- POSTDescribe a specific table version
- POSTDelete table version records
- POSTAtomically create versions for multiple tables
- POSTAtomically commit a batch of mixed table operations
- POSTModify existing columns
- POSTRemove columns from table
- POSTGet table statistics
- POSTInsert records into a table
- POSTMerge insert (upsert) records into a table
- POSTUpdate rows in a table
- POSTDelete rows from a table
- POSTQuery a table
- POSTCount rows in a table
- POSTCreate a table with the given name
- POSTGet query execution plan explanation
- POSTAnalyze query execution plan
- POSTAdd new columns to table schema
- POSTCreate an index on a table
- POSTCreate a scalar index on a table
- POSTList indexes on a table
- POSTGet table index statistics
- POSTDrop a specific index
- POSTList all tags for a table
- POSTGet version for a specific tag
- POSTDeclare a table
- POSTCreate a new tag
- POSTDelete a tag
- POSTUpdate a tag to point to a different version
A valid request URL is required to generate request examples{
"results": [
{
"declare_table": {
"transaction_id": "<string>",
"location": "<string>",
"storage_options": {},
"properties": {
"owner": "Ralph",
"created_at": "1452120468"
},
"managed_versioning": true
},
"create_table_version": {
"transaction_id": "<string>",
"version": {
"version": 1,
"manifest_path": "<string>",
"manifest_size": 1,
"e_tag": "<string>",
"timestamp_millis": 123,
"metadata": {}
}
},
"delete_table_versions": {
"deleted_count": 1,
"transaction_id": "<string>"
},
"deregister_table": {
"transaction_id": "<string>",
"id": [
"<string>"
],
"location": "<string>",
"properties": {
"owner": "Ralph",
"created_at": "1452120468"
}
}
}
],
"transaction_id": "<string>"
}Atomically commit a batch of mixed table operations
Atomically commit a batch of table operations. This is a generalized version
of BatchCreateTableVersions that supports mixed operation types within a
single atomic transaction at the metadata layer.
Supported operation types:
DeclareTable: Declare (reserve) a new tableCreateTableVersion: Create a new version entry for a tableDeleteTableVersions: Delete version ranges from a tableDeregisterTable: Deregister (soft-delete) a table
All operations are committed atomically: either all succeed or none are applied.
A valid request URL is required to generate request examples{
"results": [
{
"declare_table": {
"transaction_id": "<string>",
"location": "<string>",
"storage_options": {},
"properties": {
"owner": "Ralph",
"created_at": "1452120468"
},
"managed_versioning": true
},
"create_table_version": {
"transaction_id": "<string>",
"version": {
"version": 1,
"manifest_path": "<string>",
"manifest_size": 1,
"e_tag": "<string>",
"timestamp_millis": 123,
"metadata": {}
}
},
"delete_table_versions": {
"deleted_count": 1,
"transaction_id": "<string>"
},
"deregister_table": {
"transaction_id": "<string>",
"id": [
"<string>"
],
"location": "<string>",
"properties": {
"owner": "Ralph",
"created_at": "1452120468"
}
}
}
],
"transaction_id": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.lancedb.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
An optional delimiter of the string identifier, following the Lance Namespace spec.
When not specified, the $ delimiter must be used.
Body
Request to atomically commit a batch of table operations.
This replaces BatchCreateTableVersionsRequest with a more general interface
that supports mixed operations (DeclareTable, CreateTableVersion,
DeleteTableVersions, DeregisterTable)
within a single atomic transaction at the metadata layer.
All operations are committed atomically: either all succeed or none are applied.
List of operations to commit atomically. Supported operation types: DeclareTable, CreateTableVersion, DeleteTableVersions, DeregisterTable.
Show child attributes
Show child attributes
Identity information of a request.
Show child attributes
Show child attributes
Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.
REST NAMESPACE ONLY
Context entries are passed via HTTP headers using the naming convention
x-lance-ctx-<key>: <value>. For example, a context entry
{"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.
Show child attributes
Show child attributes
Response
Result of atomically committing a batch of mixed table operations
Response for a batch commit of table operations. Contains the results of each operation in the same order as the request.
Was this page helpful?