ALTER SINK

The ALTER SINK command modifies the metadata of a sink.

INFO

To modify the SQL definition of a sink, please refer to Alter a streaming job.

Syntax

ALTER SINK sink_name
    alter_option;

alter_option depends on the operation you want to perform on the sink. For all supported clauses, see the sections below.

Clause

OWNER TO

ALTER SINK sink_name
    OWNER TO new_user;

Parameter or clause	Description
OWNER TO	This clause changes the owner of the sink. This will cascadingly change all related internal-objects as well.
new_user	The new owner you want to assign to the sink.

-- Change the owner of the sink named "sink1" to user "user1"
ALTER SINK sink1 OWNER TO user1;

SET SCHEMA

ALTER SINK sink_name
    SET SCHEMA schema_name;

Parameter or clause	Description
SET SCHEMA	This clause moves the sink to a different schema.
schema_name	The name of the schema to which the sink will be moved.

-- Move the sink named "test_sink" to the schema named "test_schema"
ALTER SINK test_sink SET SCHEMA test_schema;

SET PARALLELISM

ALTER SINK sink_name
SET PARALLELISM { TO | = } parallelism_number;

Parameter or clause	Description
SET PARALLELISM	This clause controls the degree of parallelism for the targeted streaming job.
parallelism_number	Can be ADAPTIVE or a fixed number (e.g., 1, 2, 3). Setting it to ADAPTIVE expands the job’s parallelism to all available units, while a fixed number locks it at that value. Setting it to 0 is equivalent to ADAPTIVE.

-- Set the parallelism of the sink "s" to 4.
ALTER SINK s SET PARALLELISM = 4;

SET SINK_RATE_LIMIT

ALTER SINK sink_name
    SET SINK_RATE_LIMIT { TO | = } { default | rate_limit_number };

Use this statement to modify the rate limit of a sink. For the specific value of SINK_RATE_LIMIT, refer to How to view runtime parameters.

Example

-- Alter the rate limit of a sink to default
ALTER SINK s1 SET SINK_RATE_LIMIT = default;

-- Alter the rate limit of a sink to 1000
ALTER SINK s1 SET SINK_RATE_LIMIT = 1000;

RENAME TO

ALTER SINK sink_name
    RENAME TO new_name;

Parameter or clause	Description
RENAME TO	This clause changes the name of the sink.
new_name	The new name of the sink.

-- Change the name of the sink named "sink0" to "sink1"
ALTER SINK sink0 RENAME TO sink1;

SWAP WITH

ALTER SINK name
SWAP WITH target_name;

Parameter	Description
name	The current name of the sink to swap.
target_name	The target name of the sink you want to swap with.

-- Swap the names of the log_sink sink and the error_sink sink.
ALTER SINK log_sink
SWAP WITH error_sink;