topic_configs

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

Overview

Name	topic_configs
Type	Resource
Id	confluent.kafka.topic_configs

Fields

Name	Datatype	Description
name	string
cluster_id	string
is_default	boolean
is_read_only	boolean
is_sensitive	boolean
kind	string
metadata	object
source	string
synonyms	array
topic_name	string
value	string

Methods

Name	Accessible by	Required Params	Description
get_kafka_topic_config	SELECT	cluster_id, name, topic_name	Return the configuration parameter with the given name.
list_kafka_all_topic_configs	SELECT	cluster_id	Return the list of configuration parameters for all topics hosted by the specified cluster.
list_kafka_topic_configs	SELECT	cluster_id, topic_name	Return the list of configuration parameters that belong to the specified topic.
delete_kafka_topic_config	DELETE	cluster_id, name, topic_name	Reset the configuration parameter with given name to its default value.
update_kafka_topic_config_batch	UPDATE	cluster_id, topic_name, data__data	Update or delete a set of topic configuration parameters. Also supports a dry-run mode that only validates whether the operation would succeed if the validate_only request property is explicitly specified and set to true.
update_kafka_topic_config	EXEC	cluster_id, name, topic_name	Update the configuration parameter with given name.

SELECT examples

Return the list of configuration parameters for all topics hosted by the specified cluster.

SELECT
name,
cluster_id,
is_default,
is_read_only,
is_sensitive,
kind,
metadata,
source,
synonyms,
topic_name,
value
FROM confluent.kafka.topic_configs
WHERE cluster_id = '{{ cluster_id }}';

UPDATE example

Updates a topic_configs resource.

/*+ update */
UPDATE confluent.kafka.topic_configs
SET 
data = '{{ data }}',
validate_only = true|false
WHERE 
cluster_id = '{{ cluster_id }}'
AND topic_name = '{{ topic_name }}'
AND data__data = '{{ data__data }}';

DELETE example

Deletes the specified topic_configs resource.

/*+ delete */
DELETE FROM confluent.kafka.topic_configs
WHERE cluster_id = '{{ cluster_id }}'
AND name = '{{ name }}'
AND topic_name = '{{ topic_name }}';