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>"
  },
  "context": {},
  "id": [
    "<string>"
  ],
  "src_version": 123,
  "max_rows_per_fragment": 123,
  "concurrency": 123,
  "intra_applier_concurrency": 123,
  "source_task_size": 123,
  "cluster": "<string>",
  "output_limit": 123,
  "manifest": "<string>"
}
'
import requests

url = "{scheme}://{host}:{port}/{basePath}/v1/materialized_view/{id}/refresh"

payload = {
    "identity": {
        "api_key": "<string>",
        "auth_token": "<string>"
    },
    "context": {},
    "id": ["<string>"],
    "src_version": 123,
    "max_rows_per_fragment": 123,
    "concurrency": 123,
    "intra_applier_concurrency": 123,
    "source_task_size": 123,
    "cluster": "<string>",
    "output_limit": 123,
    "manifest": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    identity: {api_key: '<string>', auth_token: '<string>'},
    context: {},
    id: ['<string>'],
    src_version: 123,
    max_rows_per_fragment: 123,
    concurrency: 123,
    intra_applier_concurrency: 123,
    source_task_size: 123,
    cluster: '<string>',
    output_limit: 123,
    manifest: '<string>'
  })
};

fetch('{scheme}://{host}:{port}/{basePath}/v1/materialized_view/{id}/refresh', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "{scheme}://{host}:{port}/{basePath}/v1/materialized_view/{id}/refresh",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'identity' => [
        'api_key' => '<string>',
        'auth_token' => '<string>'
    ],
    'context' => [
        
    ],
    'id' => [
        '<string>'
    ],
    'src_version' => 123,
    'max_rows_per_fragment' => 123,
    'concurrency' => 123,
    'intra_applier_concurrency' => 123,
    'source_task_size' => 123,
    'cluster' => '<string>',
    'output_limit' => 123,
    'manifest' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "{scheme}://{host}:{port}/{basePath}/v1/materialized_view/{id}/refresh"

	payload := strings.NewReader("{\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"src_version\": 123,\n  \"max_rows_per_fragment\": 123,\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"source_task_size\": 123,\n  \"cluster\": \"<string>\",\n  \"output_limit\": 123,\n  \"manifest\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("{scheme}://{host}:{port}/{basePath}/v1/materialized_view/{id}/refresh")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"src_version\": 123,\n  \"max_rows_per_fragment\": 123,\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"source_task_size\": 123,\n  \"cluster\": \"<string>\",\n  \"output_limit\": 123,\n  \"manifest\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("{scheme}://{host}:{port}/{basePath}/v1/materialized_view/{id}/refresh")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identity\": {\n    \"api_key\": \"<string>\",\n    \"auth_token\": \"<string>\"\n  },\n  \"context\": {},\n  \"id\": [\n    \"<string>\"\n  ],\n  \"src_version\": 123,\n  \"max_rows_per_fragment\": 123,\n  \"concurrency\": 123,\n  \"intra_applier_concurrency\": 123,\n  \"source_task_size\": 123,\n  \"cluster\": \"<string>\",\n  \"output_limit\": 123,\n  \"manifest\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "job_id": "<string>",
  "context": {}
}
{
  "type": "/errors/bad-request",
  "title": "Malformed request",
  "status": 400,
  "detail": "",
  "instance": "/v1/namespaces"
}
{
  "type": "/errors/unauthorized-request",
  "title": "No valid authentication credentials for the operation",
  "status": 401,
  "detail": "",
  "instance": "/v1/namespaces"
}
{
  "type": "/errors/forbidden-request",
  "title": "Not authorized to make this request",
  "status": 403,
  "detail": "",
  "instance": "/v1/namespaces"
}
{
  "type": "/errors/not-found-error",
  "title": "Not found Error",
  "status": 404,
  "detail": "",
  "instance": "/v1/namespaces/{ns}"
}
{
  "type": "/errors/service-unavailable",
  "title": "Slow down",
  "status": 503,
  "detail": "",
  "instance": "/v1/namespaces"
}
{
  "type": "/errors/server-error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "",
  "instance": "/v1/namespaces"
}

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.

context
object

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

  • On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
  • On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.
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

source_task_size
integer | null

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

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

context
object

Arbitrary context as key-value pairs. How to use the context is custom to the specific implementation.

On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller.

REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the header. prefix:

  • On a request, any entry whose key starts with header. is sent as an HTTP request header with the prefix stripped. For example, the entry {"header.Authorization": "Bearer abc"} is sent as the request header Authorization: Bearer abc.
  • On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with header.. For example, the response header x-request-id: abc123 is returned as the entry {"header.x-request-id": "abc123"}.