UPDATE SECRET

Syntax

UPDATE SECRET secret_name WITH (secret_parameter = value [, ...]);

Description

Updates a new secret within the organization.

Arguments

secret_name

Name of the secret to update. If the name is case-sensitive, you must wrap it in double quotes; otherwise, the system uses the lower case name.

WITH (secret_parameter = value [, …​ ])

This clause specifies secret parameters; see secret parameters for more information.

Secret Parameters

Parameter Name	Description
description	Optional. A description for the secret Type: String
### GENERIC_SECRET Specific Parameters

Parameters to be used if type is GENERIC_SECRET:

Parameter Name	Description
secret_string	The string to store in the secret. The string may function as either an API token or a sensitive value string, to be utilized within the handler code of a user-defined function (UDF). Required: Yes Default value: None Type: String

Examples

Update a GENERIC_SECRET

The following updates a secret named my_secret:

demodb.public/demostore# UPDATE SECRET 
    my_secret
WITH ( 
    'secret_string' = 'SGVsbG8gdXBkYXRlZCBEZWx0YXNTdHJlYW0hCg==', 
    'description' = 'This is an updated generic_string secret'
);
+------------+------------+------------+------------------------------------------+
|  Type      |  Name      |  Command   |  Summary                                 |
+============+============+============+==========================================+
| secret     | my_secret  | UPDATE     | secret "my_secret" was successfully      |
|            |            |            | updated                                  |
+------------+------------+------------+------------------------------------------+