ALTER EXTERNAL CONNECTION

On this page

The ALTER EXTERNAL CONNECTION statement allows you to change the storage/sink URI that an external connection references.

You can use external connections to specify and interact with resources that are external to CockroachDB. When creating an external connection, you must define a name for the external connection while passing the provider URI and query parameters.

You can use ALTER EXTERNAL CONNECTION to update the connection string for an external connection to use a new authentication token. This allows you to rotate your auth token before the old token expires.

You can also use the following SQL statements to work with external connections:

• CREATE EXTERNAL CONNECTION
• SHOW EXTERNAL CONNECTION
• SHOW CREATE EXTERNAL CONNECTION
• DROP EXTERNAL CONNECTION

Required privileges

To update an external connection, a user must have the UPDATE privilege on that connection.

For example:

GRANT UPDATE ON EXTERNAL CONNECTION backup_bucket TO user;

Synopsis

Parameters

Supported external storage and sinks

For more information on authentication and forming the URI that an external connection will represent, refer to the storage or sink pages linked in the table.

Examples

Update the URI of an external connection

In this example, you update the backup_bucket external connection to a new Amazon S3 URI to rotate your auth token.

ALTER EXTERNAL CONNECTION backup_bucket AS 's3://bucket name?AWS_ACCESS_KEY_ID={new access key}&AWS_SECRET_ACCESS_KEY={new secret access key}';

See also

• CREATE EXTERNAL CONNECTION
• DROP EXTERNAL CONNECTION
• SHOW CREATE EXTERNAL CONNECTION