Alter Step

Summary

The ALTER STEP command modifies the attributes of an existing step object.

Syntax

alter step [if exists] <step_name> as (<command>);
alter step [if exists] <step_name> rename <new_step_name>;
alter step [if exists] <step_name> add|drop label <label_identifier>;

Parameters

Parameter
Description
<step_name> The name of an existing step object.
[if exists] Suppresses the step not found error when attempting to alter a step that does not exist in Connect.
<command> The new command to use for the step (replacing the command originally found in the step).
<new_step_name>
The name of the new step object.
<label_identifier> The label identifier. Labels allow developers to add descriptive string tags to step and pipeline objects. Labels are added to the metadata returned by the SHOW STEPS and SHOW PIPELINE commands. A step can have more than one label.

 

Examples

// Changes the command expression in the step
alter step s_1 as (insert into delta.foo select * from ReadFile(FilePath=:v_archive_path));
// Changes the name of the step
alter step s_1 rename s_2;
// An example using labels
alter step if exists s_set_period_end_date add label 'period variables and queries';
alter step s_set_var_period_name add label 'period variables and queries';
select name, labels from (show steps) where labels like '%period%';

Related Commands

CREATE STEP

DROP STEP

INVOKE STEP

SHOW STEP

SHOW STEPS