mirror_topics

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

Overview

Name	mirror_topics
Type	Resource
Id	confluent.kafka.mirror_topics

Fields

Name	Datatype	Description
kind	string
link_name	string
metadata	object
mirror_lags	array
mirror_state_transition_errors	array
mirror_status	string
mirror_topic_name	string
num_partitions	integer
source_topic_name	string
state_time_ms	integer

Methods

Name	Accessible by	Required Params	Description
list_kafka_mirror_topics	SELECT	cluster_id	List all mirror topics in the cluster
list_kafka_mirror_topics_under_link	SELECT	cluster_id, link_name	List all mirror topics under the link
read_kafka_mirror_topic	SELECT	cluster_id, link_name, mirror_topic_name
create_kafka_mirror_topic	INSERT	cluster_id, link_name, data__source_topic_name	Create a topic in the destination cluster mirroring a topic in the source cluster
update_kafka_mirror_topics_failover	EXEC	cluster_id, link_name
update_kafka_mirror_topics_pause	EXEC	cluster_id, link_name
update_kafka_mirror_topics_promote	EXEC	cluster_id, link_name
update_kafka_mirror_topics_resume	EXEC	cluster_id, link_name
update_kafka_mirror_topics_reverse_and_pause_mirror	EXEC	cluster_id, link_name
update_kafka_mirror_topics_reverse_and_start_mirror	EXEC	cluster_id, link_name
update_kafka_mirror_topics_truncate_and_restore_mirror	EXEC	cluster_id, link_name

SELECT examples

List all mirror topics in the cluster

SELECT
kind,
link_name,
metadata,
mirror_lags,
mirror_state_transition_errors,
mirror_status,
mirror_topic_name,
num_partitions,
source_topic_name,
state_time_ms
FROM confluent.kafka.mirror_topics
WHERE cluster_id = '{{ cluster_id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO confluent.kafka.mirror_topics (
data__source_topic_name,
data__mirror_topic_name,
data__replication_factor,
data__configs,
cluster_id,
link_name
)
SELECT 
'{{ source_topic_name }}',
'{{ mirror_topic_name }}',
'{{ replication_factor }}',
'{{ configs }}',
'{{ cluster_id }}',
'{{ link_name }}'
;

All Properties

/*+ create */
INSERT INTO confluent.kafka.mirror_topics (
data__source_topic_name,
cluster_id,
link_name
)
SELECT 
'{{ source_topic_name }}',
'{{ cluster_id }}',
'{{ link_name }}'
;

Manifest

- name: mirror_topics
  props:
    - name: cluster_id
      value: string
    - name: link_name
      value: string
    - name: data__source_topic_name
      value: string
    - name: source_topic_name
      value: string
    - name: mirror_topic_name
      value: string
    - name: replication_factor
      value: integer
    - name: configs
      value: array