UPDATE SCHEMA_REGISTRY

Syntax

UPDATE SCHEMA_REGISTRY
    schema_registry_name
WITH (schema_registry_parameter = value [, ... ]);

Description

Updates a schema registry with new parameters.

Arguments

schema_registry_name

Specifies the name of the new schema registry. If the name is case sensitive you must wrap it in double quotes; otherwise the system uses the lower case name.

WITH (schema_registry_parameter = value [, …​ ])

This clause specifies schema registry parameters; see schema registry parameters below for more information.

Schema Registry Parameters

Parameter Name	Description
type	Type of schema registry. Type: SCHEMA_REGISTRY_TYPE Valid values: CONFLUENT, CONFLUENT_CLOUD
access_region	Region in which the schema registry resides. Type: String Valid values: See LIST REGIONS
uris	List of comma-separated host:port URIs to connect to the schema registry. Type: String
properties.file	The file path to a .yaml file containing other schema registry parameters. Default value: None Type: String Valid values: File path in current user's filesystem

Confluent Cloud Schema Registry Specific Parameters

Parameter Name	Description
confluent_cloud.key	Credentials key for the Confluent Cloud schema registry. Default: None Type: String
confluent_cloud.secret	Credentials secret for the Confluent Cloud schema registry. Default: None Type: String

Confluent Platform Schema Registry-Specific Parameters

Parameter Name	Description
confluent.username	Login username for the Confluent Platform schema registry. Default: None Type: String
confluent.password	Login password for the Confluent Platform schema registry. Default: None Type: String
tls.client.cert_file	File path to client certificate for mutual TLS authentication in PEM format. Default: None Type: String
tls.client.key_file	File path to client certificate key for mutual TLS authentication in PEM format. Default: None Type: String

Examples

Update a Confluent Cloud schema registry with new credentials

The following updates a CONFLUENT_CLOUD schema registry named ConfluentCloudSR with new credential keys:

demodb.public/demostore#
UPDATE SCHEMA_REGISTRY "ConfluentCloudSR" WITH (
    'confluent_cloud.key' = 'fake_key',
    'confluent_cloud.secret' = 'fake_secret'
);
+-----------------+------------------+------------+------------------------------------------+
|  Type           |  Name            |  Command   |  Summary                                 |
+=================+==================+============+==========================================+
| schema registry | ConfluentCloudSR | UPDATE     | schema registry "ConfluentCloudSR" was   |
|                 |                  |            | successfully updated                     |
+-----------------+------------------+------------+------------------------------------------+

Update a Confluent Platform schema registry with new credentials

The following updates a CONFLUENT schema registry named ConfluentPlatformSR with new credential keys:

demodb.public/demostore# UPDATE SCHEMA_REGISTRY "ConfluentPlatformSR" WITH (
    'confluent.username' = 'fake_username',
    'confluent.password' = 'fake_password'
);
+-----------------+---------------------+------------+------------------------------------------+
|  Type           |  Name               |  Command   |  Summary                                 |
+=================+=====================+============+==========================================+
| schema registry | ConfluentPlatformSR | UPDATE     | schema registry "ConfluentPlatformSR"    |
|                 |                     |            | was successfully updated                 |
+-----------------+---------------------+------------+------------------------------------------+