v52

latestOpenAPI 3.1.1Apache 2.0raw.githubusercontent.com2026-08-0354155395.9 KB

MaterializedView

Data

Trigger an async materialized view refresh

Trigger an asynchronous refresh job for materialized view id. Returns a job ID for tracking.

post/v1/materialized_view/{id}/refresh

Path parameters

idstring 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

delimiterstring

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

Request body

{"stackTrail":"components:schemas:RefreshMaterializedViewRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

idstring[]

Table identifier path (namespace + table name)

src_versioninteger nullable

Optional source version to refresh from

max_rows_per_fragmentinteger nullable

Optional maximum rows per fragment

concurrencyinteger nullable

Optional concurrency override

intra_applier_concurrencyinteger nullable

Optional intra-applier concurrency override

source_task_sizeinteger nullable

Optional number of source row ids per work item during expansion. Bounds per-actor memory for chunker materialized views.

clusterstring nullable

Optional cluster name (operational override)

output_limitinteger nullable

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

manifeststring nullable

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.

Example request

{
  "src_version": 0,
  "source_task_size": 5,
  "cluster": "cluster",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "manifest": "manifest",
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "max_rows_per_fragment": 6,
  "intra_applier_concurrency": 5,
  "output_limit": 2,
  "concurrency": 1
}

Response

Refresh job accepted

{"stackTrail":"components:schemas:RefreshMaterializedViewResponse:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

job_idstring required

The job ID for tracking the refresh job

Example response

{
  "job_id": "job_id",
  "context": {
    "key": "context"
  }
}