Skip to main content
POST
/
v1
/
materialized_view
/
{id}
/
refresh
Trigger an async materialized view refresh
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/materialized_view/{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>",
  "output_limit": 123,
  "manifest": "<string>"
}
'
{
  "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

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required

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

​
delimiter
string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json
​
identity
object

Identity information of a request.

​
id
string[]

Table identifier path (namespace + table name)

​
src_version
integer | null

Optional source version to refresh from

​
max_rows_per_fragment
integer | null

Optional maximum rows per fragment

​
concurrency
integer | null

Optional concurrency override

​
intra_applier_concurrency
integer | null

Optional intra-applier concurrency override

​
cluster
string | null

Optional cluster name (operational override)

​
output_limit
integer | null

Post-trim cap on view row count after expansion. Valid only for chunker materialized views; returns 400 if set on other kinds.

​
manifest
string | null

Optional inline JSON-serialized GenevaManifest. Operational override for this refresh only; does not mutate the view's snapshotted manifest. When omitted, the manifest stored in the view's metadata is used.

Response

Refresh job accepted

​
job_id
string
required

The job ID for tracking the refresh job