top_level_config

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

Overview

Name	top_level_config
Type	Resource
Id	confluent.schema_registry.top_level_config

Fields

The following fields are returned by SELECT queries:

get_top_level_config

The global compatibility level.

Name	Datatype	Description
alias	string	If alias is specified, then this subject is an alias for the subject named by the alias. That means that any reference to this subject will be replaced by the alias.
compatibilityGroup	string	Only schemas that belong to the same compatibility group will be checked for compatibility.
compatibilityLevel	string	Compatibility Level (example: FULL_TRANSITIVE)
defaultMetadata	object	Default value for the metadata to be used during schema registration.
defaultRuleSet	object	Default value for the ruleSet to be used during schema registration.
normalize	boolean	If true, then schemas are automatically normalized when registered or when passed during lookups. This means that clients do not have to pass the "normalize" query parameter to have normalization occur.
overrideMetadata	object	Override value for the metadata to be used during schema registration.
overrideRuleSet	object	Override value for the ruleSet to be used during schema registration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_top_level_config	select			Retrieves the global compatibility level, compatibility group, normalization, default metadata, and rule set.
update_top_level_config	replace			Updates the global compatibility level, compatibility group, schema normalization, default metadata, and rule set. On success, echoes the original request back to the client.
delete_top_level_config	delete			Deletes the global compatibility level config and reverts to the default.

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

SELECT examples

get_top_level_config

Retrieves the global compatibility level, compatibility group,
normalization, default metadata, and rule set.

SELECT
alias,
compatibilityGroup,
compatibilityLevel,
defaultMetadata,
defaultRuleSet,
normalize,
overrideMetadata,
overrideRuleSet
FROM confluent.schema_registry.top_level_config
;

REPLACE examples

update_top_level_config

Updates the global compatibility level, compatibility group,
schema normalization, default metadata, and rule set. On success, echoes the
original request back to the client.

REPLACE confluent.schema_registry.top_level_config
SET 
alias = '{{ alias }}',
normalize = {{ normalize }},
compatibility = '{{ compatibility }}',
compatibilityGroup = '{{ compatibilityGroup }}',
defaultMetadata = '{{ defaultMetadata }}',
overrideMetadata = '{{ overrideMetadata }}',
defaultRuleSet = '{{ defaultRuleSet }}',
overrideRuleSet = '{{ overrideRuleSet }}'
RETURNING
alias,
compatibility,
compatibilityGroup,
defaultMetadata,
defaultRuleSet,
normalize,
overrideMetadata,
overrideRuleSet;

DELETE examples

delete_top_level_config

Deletes the global compatibility level config and reverts to the default.

DELETE FROM confluent.schema_registry.top_level_config
;