exporters

Creates, updates, deletes, gets or lists an exporters resource.

Overview

Name	exporters
Type	Resource
Id	confluent.schema_registry.exporters

Fields

The following fields are returned by SELECT queries:

get_exporter_info_by_name

The original request.

Name	Datatype	Description
name	string	Name of the exporter (example: test-exporter)
config	object	The map containing exporter's configurations
context	string	Customized context of the exporter if contextType equals CUSTOM. (example: User)
contextType	string	Context type of the exporter. One of CUSTOM, NONE or AUTO (default) (example: CUSTOM)
kekRenameFormat	string	Format string for the KEK name in the destination cluster, which may contain ${kek} as a placeholder for the originating KEK name. For example, dc_${kek} for the KEK aws_key will map to the destination KEK name dc_aws_key.
subjectRenameFormat	string	Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
subjects	array	Name of each exporter subject

list_exporters

Name of the exporter

Name	Datatype	Description
exporter	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_exporter_info_by_name	select	name		Retrieves the information of the schema exporter.
list_exporters	select			Retrieves a list of schema exporters that have been created.
register_exporter	insert			Creates a new schema exporter. All attributes in request body are optional except config.
update_exporter_info	replace	name		Updates the information or configurations of the schema exporter. All attributes in request body are optional.
delete_exporter	delete	name		Deletes the schema exporter.
pause_exporter_by_name	exec	name		Pauses the state of the schema exporter.
reset_exporter_by_name	exec	name		Reset the state of the schema exporter.
resume_exporter_by_name	exec	name		Resume running of the schema exporter.

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
name	string	Name of the exporter

SELECT examples

get_exporter_info_by_name

Retrieves the information of the schema exporter.

SELECT
name,
config,
context,
contextType,
kekRenameFormat,
subjectRenameFormat,
subjects
FROM confluent.schema_registry.exporters
WHERE name = '{{ name }}' -- required
;

list_exporters

Retrieves a list of schema exporters that have been created.

SELECT
exporter
FROM confluent.schema_registry.exporters
;

INSERT examples

register_exporter

Creates a new schema exporter. All attributes in request body are optional except config.

INSERT INTO confluent.schema_registry.exporters (
name,
contextType,
context,
subjects,
kekRenameFormat,
subjectRenameFormat,
config
)
SELECT 
'{{ name }}',
'{{ contextType }}',
'{{ context }}',
'{{ subjects }}',
'{{ kekRenameFormat }}',
'{{ subjectRenameFormat }}',
'{{ config }}'
RETURNING
name
;

Manifest

# Description fields are for documentation purposes
- name: exporters
props:
  - name: name
    value: "{{ name }}"
    description: |
      Name of the exporter
  - name: contextType
    value: "{{ contextType }}"
    description: |
      Context type of the exporter. One of CUSTOM, NONE or AUTO (default)
  - name: context
    value: "{{ context }}"
    description: |
      Customized context of the exporter if contextType equals CUSTOM.
  - name: subjects
    value:
      - "{{ subjects }}"
    description: |
      Name of each exporter subject
  - name: kekRenameFormat
    value: "{{ kekRenameFormat }}"
    description: |
      Format string for the KEK name in the destination cluster, which may contain ${kek} as a placeholder for the originating KEK name. For example, dc_${kek} for the KEK aws_key will map to the destination KEK name dc_aws_key.
  - name: subjectRenameFormat
    value: "{{ subjectRenameFormat }}"
    description: |
      Format string for the subject name in the destination cluster, which may contain ${subject} as a placeholder for the originating subject name. For example, dc_${subject} for the subject orders will map to the destination subject name dc_orders.
  - name: config
    value: "{{ config }}"
    description: |
      The map containing exporter's configurations

REPLACE examples

update_exporter_info

Updates the information or configurations of the schema exporter. All attributes in request body are optional.

REPLACE confluent.schema_registry.exporters
SET 
contextType = '{{ contextType }}',
context = '{{ context }}',
subjects = '{{ subjects }}',
kekRenameFormat = '{{ kekRenameFormat }}',
subjectRenameFormat = '{{ subjectRenameFormat }}',
config = '{{ config }}'
WHERE 
name = '{{ name }}' --required
RETURNING
name;

DELETE examples

delete_exporter

Deletes the schema exporter.

DELETE FROM confluent.schema_registry.exporters
WHERE name = '{{ name }}' --required
;

Lifecycle Methods

pause_exporter_by_name

Pauses the state of the schema exporter.

EXEC confluent.schema_registry.exporters.pause_exporter_by_name 
@name='{{ name }}' --required
;

reset_exporter_by_name

Reset the state of the schema exporter.

EXEC confluent.schema_registry.exporters.reset_exporter_by_name 
@name='{{ name }}' --required
;

resume_exporter_by_name

Resume running of the schema exporter.

EXEC confluent.schema_registry.exporters.resume_exporter_by_name 
@name='{{ name }}' --required
;