Cloud

ALTER REDPANDA CATALOG

The ALTER REDPANDA CATALOG statement modifies connection properties of an existing Redpanda catalog. You can also use it to link the Redpanda catalog to an Iceberg catalog (or detach an existing link) so that queries against the Redpanda catalog return both live records and Iceberg-translated history (records previously written from the topic into the linked Iceberg catalog). See Query Iceberg-enabled Topics for details.

In Redpanda Cloud, the storage connection and Iceberg catalog used to query Iceberg-enabled topics are configured and managed automatically when you enable Redpanda SQL on a cluster that has an Iceberg REST catalog configured. You don’t run these statements yourself for that workflow. This page documents the statement’s syntax and options so you can understand what Redpanda Cloud configures. See Query Iceberg-enabled topics.
Do not reset or change the options of default_redpanda_catalog. Redpanda Cloud manages these options, and a reset or change can break queries. On a cluster with Iceberg enabled, Redpanda Cloud sets the options again when the Iceberg configuration changes, such as when a secret rotates.

Syntax

ALTER REDPANDA CATALOG [IF EXISTS] catalog_name
WITH (option = 'value' [, ...])
[RESET (option [, ...])];

ALTER REDPANDA CATALOG [IF EXISTS] catalog_name
RESET (option [, ...]);

ALTER REDPANDA CATALOG [IF EXISTS] catalog_name
USING CATALOG [schema.]iceberg_catalog_name
[WITH (option = 'value' [, ...])];

ALTER REDPANDA CATALOG [IF EXISTS] catalog_name
USING CATALOG NULL
[WITH (option = 'value' [, ...])];

  • catalog_name: Name of the Redpanda catalog to modify.

  • IF EXISTS: Optional. Prevents an error if the catalog does not exist.

  • option = 'value': One or more connection options to update. See CREATE REDPANDA CATALOG for the full list of options.

  • USING CATALOG iceberg_catalog_name: Links the Redpanda catalog to an existing Iceberg catalog. The Iceberg catalog must already exist. You can qualify the Iceberg catalog name with a schema prefix.

  • USING CATALOG NULL: Detaches the Redpanda catalog from any linked Iceberg catalog.

  • RESET (option [, …​]): Removes the values of one or more options. Redpanda SQL then uses the default for each option. You cannot use RESET with USING CATALOG.

Reset options

You can reset these options. For what each option does, see CREATE REDPANDA CATALOG.

Option Reset behavior

sasl_mechanism, sasl_user, sasl_password

If you reset one of these options, Redpanda SQL resets all three.

truststore

Redpanda SQL resets only this option.

key_store_key, key_store_cert

If you reset one of these options, Redpanda SQL resets both.

pandaproxy_url

Redpanda SQL resets only this option.

The initial_brokers and schema_registry_url options are required. You cannot reset them. The statement fails with cannot RESET required option <option>.

You cannot set and reset the same option in one statement. The statement fails with option <option> cannot be both set and reset in the same statement.

Examples

Update broker address

ALTER REDPANDA CATALOG production_redpanda
WITH (initial_brokers = 'new-broker:9092');

To link a Redpanda catalog to an existing Iceberg catalog so that queries against the Redpanda catalog return both live records and Iceberg-translated history:

ALTER REDPANDA CATALOG production_redpanda
USING CATALOG lakehouse_catalog;

Detach from an Iceberg catalog

To remove an existing link to an Iceberg catalog so that queries against the Redpanda catalog return only live records:

ALTER REDPANDA CATALOG production_redpanda
USING CATALOG NULL;

Remove SASL credentials

To remove the SASL credentials from a Redpanda catalog:

ALTER REDPANDA CATALOG production_redpanda
RESET (sasl_mechanism, sasl_user, sasl_password);

Replace credentials and remove the HTTP Proxy URL

To set new SASL credentials and remove the HTTP Proxy URL in one statement:

ALTER REDPANDA CATALOG production_redpanda
WITH (sasl_mechanism = 'SCRAM-SHA-256', sasl_user = 'admin', sasl_password = 'secret')
RESET (pandaproxy_url);