share_groups

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

Overview

Name	share_groups
Type	Resource
Id	confluent.share_group.share_groups

Fields

The following fields are returned by SELECT queries:

get_kafka_share_group

The share group.

Name	Datatype	Description
cluster_id	string
share_group_id	string
assigned_topic_partitions	array	List of topic-partitions assigned to this share group, including those from empty groups
consumer_count	integer (int32)	Number of consumers in this share group
consumers	object
coordinator	object
kind	string
metadata	object
partition_count	integer (int32)	Total number of partitions assigned to this share group across all consumers
state	string

list_kafka_share_groups

The list of share groups.

Name	Datatype	Description
cluster_id	string
share_group_id	string
assigned_topic_partitions	array	List of topic-partitions assigned to this share group, including those from empty groups
consumer_count	integer (int32)	Number of consumers in this share group
consumers	object
coordinator	object
kind	string
metadata	object
partition_count	integer (int32)	Total number of partitions assigned to this share group across all consumers
state	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_kafka_share_group	select	cluster_id, group_id		Return the share group specified by the group_id.
list_kafka_share_groups	select	cluster_id		Return the list of share groups that belong to the specified Kafka cluster.
delete_kafka_share_group	delete	cluster_id, group_id		Delete the share group specified by the group_id.

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
cluster_id	string	The Kafka cluster ID. (example: cluster-1)
group_id	string	The group ID. (example: group-1)

SELECT examples

get_kafka_share_group

Return the share group specified by the group_id.

SELECT
cluster_id,
share_group_id,
assigned_topic_partitions,
consumer_count,
consumers,
coordinator,
kind,
metadata,
partition_count,
state
FROM confluent.share_group.share_groups
WHERE cluster_id = '{{ cluster_id }}' -- required
AND group_id = '{{ group_id }}' -- required
;

list_kafka_share_groups

Return the list of share groups that belong to the specified
Kafka cluster.

SELECT
cluster_id,
share_group_id,
assigned_topic_partitions,
consumer_count,
consumers,
coordinator,
kind,
metadata,
partition_count,
state
FROM confluent.share_group.share_groups
WHERE cluster_id = '{{ cluster_id }}' -- required
;

DELETE examples

delete_kafka_share_group

Delete the share group specified by the group_id.

DELETE FROM confluent.share_group.share_groups
WHERE cluster_id = '{{ cluster_id }}' --required
AND group_id = '{{ group_id }}' --required
;