ALTER EXTERNAL CONSUMER¶

Modifies the properties of an existing external consumer, or manages its Programmatic Access Tokens (PATs).

See also:: CREATE EXTERNAL CONSUMER , DROP EXTERNAL CONSUMER , ALTER EXTERNAL CONSUMER … ADD PROGRAMMATIC ACCESS TOKEN (PAT) , ALTER EXTERNAL CONSUMER … REMOVE PROGRAMMATIC ACCESS TOKEN (PAT) , ALTER EXTERNAL CONSUMER … ROTATE PROGRAMMATIC ACCESS TOKEN (PAT) , ALTER EXTERNAL CONSUMER … MODIFY PROGRAMMATIC ACCESS TOKEN (PAT) , SHOW EXTERNAL CONSUMERS

Syntax¶

ALTER EXTERNAL CONSUMER [ IF EXISTS ] <name> SET
  [ COMMENT = '<string_literal>' ]
  [ EMAIL = '<email_address>' ]

ALTER EXTERNAL CONSUMER [ IF EXISTS ] <name> UNSET
  [ COMMENT ]
  [ EMAIL ]

ALTER EXTERNAL CONSUMER [ IF EXISTS ] <name> RENAME TO <new_name>

For PAT operations, see:

IF EXISTS: Applies the change only if an external consumer with the specified name exists. If no external consumer with that name exists, the command does nothing and completes successfully instead of returning an error.
name: Specifies the identifier for the external consumer to modify.
COMMENT = 'string_literal': Specifies a new comment for the external consumer.
EMAIL = 'email_address': Specifies a new email address for the external consumer.
RENAME TO new_name: Renames the external consumer to the specified identifier.

A role used to execute this operation must have the following privileges at a minimum:

Privilege	Object	Notes
OWNERSHIP	External Consumer	Required to modify the properties of the consumer.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Update the comment on an external consumer:

ALTER EXTERNAL CONSUMER acme_consumer SET COMMENT = 'Updated contact for Acme Corp';

Rename an external consumer:

ALTER EXTERNAL CONSUMER acme_consumer RENAME TO acme_corp_consumer;

Remove the email from an external consumer:

ALTER EXTERNAL CONSUMER acme_consumer UNSET EMAIL;