ContextQMD
Back to Materialize

ALTER SECRET

doc/user/content/sql/alter-secret.md

1232.0 KB
Original Source

Use ALTER SECRET to:

  • Change the value of the secret.
  • Rename a secret.
  • Change owner of a secret.

Syntax

{{< tabs >}} {{< tab "Change value" >}}

Change value

To change the value of a secret:

{{% include-syntax file="examples/alter_secret" example="syntax-change-value" %}}

{{< /tab >}} {{< tab "Rename" >}}

Rename

To rename a secret:

{{% include-syntax file="examples/alter_secret" example="syntax-rename" %}}

{{< /tab >}} {{< tab "Change owner" >}}

Change owner

To change the owner of a secret:

{{% include-syntax file="examples/alter_secret" example="syntax-change-owner" %}}

{{< /tab >}} {{< /tabs >}}

Details

Changing the secret value

After an ALTER SECRET command is executed:

  • Future CREATE CONNECTION, CREATE SOURCE, and CREATE SINK commands will use the new value of the secret immediately.

  • Running sources and sinks that reference the secret will not immediately use the new value of the secret. Sources and sinks may cache the old secret value for several weeks.

    To force a running source or sink to refresh its secrets, drop and recreate all replicas of the cluster hosting the source or sink.

    For a managed cluster:

    ALTER CLUSTER storage_cluster SET (REPLICATION FACTOR = 0);
ALTER CLUSTER storage_cluster SET (REPLICATION FACTOR = 1);

    For an unmanaged cluster:

    DROP CLUSTER REPLICA storage_cluster.r1;
CREATE CLUSTER REPLICA storage_cluster.r1 (SIZE = '<original size>');
    ```

Examples

mzsql
ALTER SECRET kafka_ca_cert AS decode('c2VjcmV0Cg==', 'base64');

Privileges

The privileges required to execute this statement are:

{{% include-headless "/headless/sql-command-privileges/alter-secret" %}}