topics

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

Overview

Name	topics
Type	Resource
Id	confluent.tableflow.topics

Fields

The following fields are returned by SELECT queries:

get_tableflow_v1_tableflow_topic

Tableflow Topic.

Name	Datatype	Description
api_version	string	APIVersion defines the schema version of this representation of a resource. (tableflow/v1)
kind	string	Kind defines the object this REST resource represents. (TableflowTopic)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Tableflow Topic
status	object	The status of the Tableflow Topic

list_tableflow_v1_tableflow_topics

Tableflow Topic.

Name	Datatype	Description
api_version	string	APIVersion defines the schema version of this representation of a resource. (tableflow/v1)
kind	string	Kind defines the object this REST resource represents. (TableflowTopic)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Tableflow Topic
status	object	The status of the Tableflow Topic

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_tableflow_v1_tableflow_topic	select	environment, spec.kafka_cluster, display_name		Make a request to read a tableflow topic.
list_tableflow_v1_tableflow_topics	select	environment, spec.kafka_cluster	spec.table_formats, page_size, page_token	Retrieve a sorted, filtered, paginated list of all tableflow topics.
create_tableflow_v1_tableflow_topic	insert	spec		Make a request to create a tableflow topic.
update_tableflow_v1_tableflow_topic	update	display_name, spec		Make a request to update a tableflow topic.
delete_tableflow_v1_tableflow_topic	delete	environment, spec.kafka_cluster, display_name		Make a request to delete a tableflow topic.

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
display_name	string	The name of the Kafka topic for which Tableflow is enabled.
environment	string	Scope the operation to the given environment. (example: env-00000)
spec.kafka_cluster	string	Scope the operation to the given spec.kafka_cluster. (example: lkc-00000)
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
spec.table_formats	array	Filter the results by exact match for spec.table_formats. Pass multiple times to see results matching any of the values. (example: [DELTA, ICEBERG])

SELECT examples

get_tableflow_v1_tableflow_topic

Make a request to read a tableflow topic.

SELECT
api_version,
kind,
metadata,
spec,
status
FROM confluent.tableflow.topics
WHERE environment = '{{ environment }}' -- required
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required
AND display_name = '{{ display_name }}' -- required
;

list_tableflow_v1_tableflow_topics

Retrieve a sorted, filtered, paginated list of all tableflow topics.

SELECT
api_version,
kind,
metadata,
spec,
status
FROM confluent.tableflow.topics
WHERE environment = '{{ environment }}' -- required
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' -- required
AND spec.table_formats = '{{ spec.table_formats }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_tableflow_v1_tableflow_topic

Make a request to create a tableflow topic.

INSERT INTO confluent.tableflow.topics (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: topics
props:
  - name: spec
    description: |
      The desired state of the Tableflow Topic
    value:
      display_name: "{{ display_name }}"
      suspended: {{ suspended }}
      config:
        enable_compaction: {{ enable_compaction }}
        enable_partitioning: {{ enable_partitioning }}
        retention_ms: "{{ retention_ms }}"
        data_retention_ms: "{{ data_retention_ms }}"
        record_failure_strategy: "{{ record_failure_strategy }}"
        error_handling:
          mode: "{{ mode }}"
          target: "{{ target }}"
      storage:
        kind: "{{ kind }}"
        bucket_name: "{{ bucket_name }}"
        bucket_region: "{{ bucket_region }}"
        provider_integration_id: "{{ provider_integration_id }}"
        table_path: "{{ table_path }}"
        storage_account_name: "{{ storage_account_name }}"
        container_name: "{{ container_name }}"
        storage_region: "{{ storage_region }}"
      table_formats:
        - "{{ table_formats }}"
      environment:
        id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
      kafka_cluster:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_tableflow_v1_tableflow_topic

Make a request to update a tableflow topic.

UPDATE confluent.tableflow.topics
SET 
spec = '{{ spec }}'
WHERE 
display_name = '{{ display_name }}' --required
AND spec = '{{ spec }}' --required
RETURNING
api_version,
kind,
metadata,
spec,
status;

DELETE examples

delete_tableflow_v1_tableflow_topic

Make a request to delete a tableflow topic.

DELETE FROM confluent.tableflow.topics
WHERE environment = '{{ environment }}' --required
AND spec.kafka_cluster = '{{ spec.kafka_cluster }}' --required
AND display_name = '{{ display_name }}' --required
;