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}/refresh \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity": {
"api_key": "<string>",
"auth_token": "<string>"
},
"id": [
"<string>"
],
"src_version": 123,
"max_rows_per_fragment": 123,
"concurrency": 123,
"intra_applier_concurrency": 123,
"cluster": "<string>",
"manifest": "<string>"
}
'{
"job_id": "<string>"
}Trigger an async materialized view refresh
Trigger an asynchronous refresh job for a materialized view backed by table id.
Returns a job ID for tracking.
A valid request URL is required to generate request examples{
"job_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.
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
Identity information of a request.
Show child attributes
Show child attributes
Table identifier path (namespace + table name)
Optional source version to refresh from
Optional maximum rows per fragment
Optional concurrency override
Optional intra-applier concurrency override
Optional cluster name
Optional manifest name
Response
Refresh job accepted
The job ID for tracking the refresh job
Was this page helpful?