materialized_table_versions

Creates, updates, deletes, gets or lists a materialized_table_versions resource.

Overview

Name	materialized_table_versions
Type	Resource
Id	confluent.sql.materialized_table_versions

Fields

The following fields are returned by SELECT queries:

get_sqlv1_materialized_table_version

The requested Materialized Table Version.

Name	Datatype	Description
name	string	The resource version name, unique within the Kafka cluster. Name conforms to DNS Subdomain (RFC 1123). (pattern: [a-z0-9]([-a-z0-9][a-z0-9])?(.[a-z0-9]([-a-z0-9][a-z0-9])?)*, example: mt-123-v4)
environment_id	string	The unique identifier for the environment.
organization_id	string (uuid)	The unique identifier for the organization.
api_version	string	APIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
kind	string	Kind defines the object this REST resource represents. (MaterializedTableVersion)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The specifications of the Materialized Table Version.

list_sqlv1_materialized_table_versions

A list of Materialized Table Versions.

Name	Datatype	Description
name	string	The resource version name, unique within the Kafka cluster. Name conforms to DNS Subdomain (RFC 1123). (pattern: [a-z0-9]([-a-z0-9][a-z0-9])?(.[a-z0-9]([-a-z0-9][a-z0-9])?)*, example: mt-123-v4)
environment_id	string	The unique identifier for the environment.
organization_id	string (uuid)	The unique identifier for the organization.
api_version	string	APIVersion defines the schema version of this representation of a resource. (sql/v1) (example: sql/v1)
kind	string	Kind defines the object this REST resource represents. (MaterializedTableVersion)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The specifications of the Materialized Table Version.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sqlv1_materialized_table_version	select	organization_id, environment_id, kafka_cluster_id, table_name, version		Retrieve a specific version of a Materialized Table.
list_sqlv1_materialized_table_versions	select	organization_id, environment_id, kafka_cluster_id, table_name	page_size, page_token	Retrieve a sorted and paginated list of all versions for a specific Materialized Table.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string	The unique identifier for the environment.
kafka_cluster_id	string	The unique identifier for the database.
organization_id	string (uuid)	The unique identifier for the organization.
table_name	string	The unique identifier for the Materialized Table.
version	integer (int32)	The version number of the Materialized Table.
page_size	integer (int32)	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_sqlv1_materialized_table_version

Retrieve a specific version of a Materialized Table.

SELECT
name,
environment_id,
organization_id,
api_version,
kind,
metadata,
spec
FROM confluent.sql.materialized_table_versions
WHERE organization_id = '{{ organization_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
AND table_name = '{{ table_name }}' -- required
AND version = '{{ version }}' -- required
;

list_sqlv1_materialized_table_versions

Retrieve a sorted and paginated list of all versions for a specific Materialized Table.

SELECT
name,
environment_id,
organization_id,
api_version,
kind,
metadata,
spec
FROM confluent.sql.materialized_table_versions
WHERE organization_id = '{{ organization_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND kafka_cluster_id = '{{ kafka_cluster_id }}' -- required
AND table_name = '{{ table_name }}' -- required
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;