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
curl --request POST \
--url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/version/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"version": 1,
"manifest_path": "<string>",
"identity": {
"api_key": "<string>",
"auth_token": "<string>"
},
"context": {},
"id": [
"<string>"
],
"manifest_size": 1,
"e_tag": "<string>",
"metadata": {},
"naming_scheme": "V2"
}
'{
"transaction_id": "<string>",
"version": {
"version": 1,
"manifest_path": "<string>",
"manifest_size": 1,
"e_tag": "<string>",
"timestamp_millis": 123,
"metadata": {}
}
}Create a new table version
Create a new version entry for table id.
This operation supports put_if_not_exists semantics.
The operation will fail with 409 Conflict if the version already exists.
A valid request URL is required to generate request examples{
"transaction_id": "<string>",
"version": {
"version": 1,
"manifest_path": "<string>",
"manifest_size": 1,
"e_tag": "<string>",
"timestamp_millis": 123,
"metadata": {}
}
}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.
Path Parameters
string identifier of an object in a namespace, following the Lance Namespace spec.
When the value is equal to the delimiter, it represents the root namespace.
For example, v1/namespace/$/list performs a ListNamespace on the root namespace.
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 create a new table version entry.
This supports put_if_not_exists semantics,
where the operation fails if the version already exists.
Version number to create
x >= 0Path to the manifest file for this version
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
The table identifier
Size of the manifest file in bytes
x >= 0Optional ETag for the manifest file
Optional metadata for the version
Show child attributes
Show child attributes
The naming scheme used for manifest files in the _versions/ directory.
Known values:
V1:_versions/{version}.manifest- Simple version-based namingV2:_versions/{inverted_version}.manifest- Zero-padded, reversed version number (usesu64::MAX - version) for O(1) lookup of latest version on object stores
V2 is preferred for new tables as it enables efficient latest-version discovery without needing to list all versions.
"V2"
Was this page helpful?