Read a materialized view

Returns the rows of a materialized view, filtered and masked by the caller's row-level policies.

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

Read a view through the caller's policiesStored view rows may be older than the base table.

Select the viewIdentify the materialized result to read.
Apply row policies and masksRestrict the stored data for this caller.
Read the returned rowsRefresh an on-demand view when updated contents are needed.

Before you start

Use your database bearer token.

Use an existing materialized view. The example targets demo_scores; on-demand views must be refreshed when you need updated rows.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`name`	`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

rows contains stored view data after the caller's row policies and masks. This is not necessarily a fresh read of the base table; refresh an on-demand view when you need updated contents.

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.
404	Check the resource ID and API route.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
502	Check service availability and the write outcome.
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/demo_scores" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "name": "demo_scores",
  "rows": [
    {
      "id": "u1",
      "score": 10
    },
    {
      "id": "u2",
      "score": 20
    },
    {
      "id": "u3",
      "score": 30
    }
  ]
}

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