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

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

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,
  "cluster": "cluster",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "manifest": "manifest",
  "id": [
    "id",
    "id"
  ],
  "max_rows_per_fragment": 6,
  "intra_applier_concurrency": 5,
  "output_limit": 5,
  "concurrency": 1
}

Response

Refresh job accepted

job_idstring required

The job ID for tracking the refresh job

Example response

{
  "job_id": "job_id"
}