ALTER GATEWAY¶

Modifies the configuration of an existing gateway. Use this command to update the traffic split configuration for a gateway.

See also:: CREATE GATEWAY , DESCRIBE GATEWAY, DROP GATEWAY , SHOW GATEWAYS

Syntax¶

ALTER GATEWAY [ IF EXISTS ] <name>
  FROM SPECIFICATION <specification_text>

Copy

Parameters¶

name

Specifies the identifier for the gateway to alter.

If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

For more information, see Identifier requirements.

FROM SPECIFICATION

Specifies the updated gateway specification inline. The specification defines the traffic split configuration.

The specification uses the following format:

spec:
  type: traffic_split
  split_type: custom
  targets:
  - type: endpoint
    value: <db>.<schema>.<service>!<endpoint>
    weight: <weight>
  - type: endpoint
    value: <db>.<schema>.<service>!<endpoint>
    weight: <weight>

Copy

Specification parameters¶

type

Fixed value. Must be set to traffic_split.

split_type

Fixed value. Must be set to custom.

targets

A list of target endpoints to route traffic to. Each target must specify:

type: Fixed value. Must be set to endpoint.
value: The fully qualified endpoint name in the format db.schema.service!endpoint. Each target endpoint must exist.
weight: The traffic weight for this endpoint, specified as an integer. All weights must add up to 100.

Note

Maximum number of endpoints per gateway is 5 by default.

Access control requirements¶

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

Privilege	Object	Notes
MODIFY or OWNERSHIP	Gateway	Required to alter the gateway configuration.
BIND SERVICE ENDPOINT	Account	Required to bind service endpoints to the gateway.
USAGE	Database	Required on the database containing the gateway.
USAGE	Schema	Required on the schema containing the gateway.
USAGE	Service endpoints	Required on the target service endpoints.

To grant the required privileges, use the following commands:

-- Grant MODIFY or OWNERSHIP privilege on the gateway
GRANT MODIFY ON GATEWAY <gateway_name> TO ROLE <role_name>;
-- OR
GRANT OWNERSHIP ON GATEWAY <gateway_name> TO ROLE <role_name>;

-- Grant BIND SERVICE ENDPOINT privilege on the account
GRANT BIND SERVICE ENDPOINT ON ACCOUNT TO ROLE <role_name>;

Copy

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.

Usage notes¶

Regarding metadata:

Attention

Customers should ensure that no personal data (other than for a User object), sensitive data, export-controlled data, or other regulated data is entered as metadata when using the Snowflake service. For more information, see Metadata fields in Snowflake.

Examples¶

Alter a gateway to update the traffic split configuration:

ALTER GATEWAY split_gateway
  FROM SPECIFICATION $$
spec:
  type: traffic_split
  split_type: custom
  targets:
  - type: endpoint
    value: db.schema.s2!ep1
    weight: 60
  - type: endpoint
    value: db.schema.s1!ep1
    weight: 40
$$;

Copy