List materialized views

Lists the materialized views installed for the tenant with their refresh mode and base table.

GET /v1/tenants/{tenant}/sql/materialized-views

Find stored views and their freshness settingsA listed view may still need warming or refresh.

List installed viewsRequest the tenant's view definitions.
Inspect source and refresh modeIdentify how each view relates to its base table.
Check the warming stateDecide whether its stored result is ready for use.

Before you start

Use your database bearer token.

Path parameters

Field	Type	Required
`tenant`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Inspect each view's refresh_mode, source_schema and warming state. A listed view may still need refresh or warming before its stored rows suit your use case.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
429	Honor Retry-After when present; back off.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/sql/materialized-views" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

[
  {
    "name": "demo_scores",
    "refresh_mode": "on_demand",
    "source_schema": "demo.people",
    "warming": false
  }
]

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses