topics

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

Overview

Name	topics
Type	Resource
Id	confluent.kafka.topics

Fields

Name	Datatype	Description
authorized_operations	array
cluster_id	string
configs	object
is_internal	boolean
kind	string
metadata	object
partition_reassignments	object
partitions	object
partitions_count	integer
replication_factor	integer
topic_name	string

Methods

Name	Accessible by	Required Params	Description
get_kafka_topic	SELECT	cluster_id, topic_name	Return the topic with the given topic_name.
list_kafka_topics	SELECT	cluster_id	Return the list of topics that belong to the specified Kafka cluster.
create_kafka_topic	INSERT	cluster_id, data__topic_name	Create a topic. Also supports a dry-run mode that only validates whether the topic creation would succeed if the validate_only request property is explicitly specified and set to true. Note that when dry-run mode is being used the response status would be 200 OK instead of 201 Created.
delete_kafka_topic	DELETE	cluster_id, topic_name	Delete the topic with the given topic_name.
update_partition_count_kafka_topic	UPDATE	cluster_id, topic_name, data__partitions_count	Increase the number of partitions for a topic.

SELECT examples

Return the list of topics that belong to the specified Kafka cluster.

SELECT
authorized_operations,
cluster_id,
configs,
is_internal,
kind,
metadata,
partition_reassignments,
partitions,
partitions_count,
replication_factor,
topic_name
FROM confluent.kafka.topics
WHERE cluster_id = '{{ cluster_id }}';

INSERT example

Use the following StackQL query and manifest file to create a new topics resource.

Required Properties

/*+ create */
INSERT INTO confluent.kafka.topics (
data__topic_name,
data__partitions_count,
data__replication_factor,
data__configs,
data__validate_only,
cluster_id
)
SELECT 
'{{ topic_name }}',
'{{ partitions_count }}',
'{{ replication_factor }}',
'{{ configs }}',
'{{ validate_only }}',
'{{ cluster_id }}'
;

All Properties

/*+ create */
INSERT INTO confluent.kafka.topics (
data__topic_name,
cluster_id
)
SELECT 
'{{ topic_name }}',
'{{ cluster_id }}'
;

Manifest

- name: topics
  props:
    - name: cluster_id
      value: string
    - name: data__topic_name
      value: string
    - name: topic_name
      value: string
    - name: partitions_count
      value: integer
    - name: replication_factor
      value: integer
    - name: configs
      value: array
      props:
        - name: name
          value: string
        - name: value
          value: string
    - name: validate_only
      value: boolean

UPDATE example

Updates a topics resource.

/*+ update */
UPDATE confluent.kafka.topics
SET 
partitions_count = '{{ partitions_count }}'
WHERE 
cluster_id = '{{ cluster_id }}'
AND topic_name = '{{ topic_name }}'
AND data__partitions_count = '{{ data__partitions_count }}';

DELETE example

Deletes the specified topics resource.

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