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
- POSTTrigger an async column backfill job
- POSTTrigger an async materialized view refresh
- 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{
"versions": [
{
"version": 1,
"manifest_path": "<string>",
"manifest_size": 1,
"e_tag": "<string>",
"timestamp_millis": 123,
"metadata": {}
}
],
"transaction_id": "<string>"
}Atomically create versions for multiple tables
Atomically create new version entries for multiple tables.
This operation is atomic: either all table versions are created successfully, or none are created. If any version creation fails (e.g., due to conflict), the entire batch operation fails.
Each entry in the request specifies the table identifier and version details.
This supports put_if_not_exists semantics for each version entry.
A valid request URL is required to generate request examples{
"versions": [
{
"version": 1,
"manifest_path": "<string>",
"manifest_size": 1,
"e_tag": "<string>",
"timestamp_millis": 123,
"metadata": {}
}
],
"transaction_id": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://lancedb-bcbb4faf-docs-namespace-typescript-examples.mintlify.app/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 create new version entries for multiple tables. The operation is atomic: all versions are created or none are.
List of table version entries to create atomically
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 creating table versions
Was this page helpful?