Configuring a Stored Procedure Executor

Configure a Stored Procedure executor to include a Snowflake stored procedure in the pipeline to perform a task.

Unlike other executors, you create a Stored Procedure executor from the Functions tab of the Stage Selector dialog box. This creates a custom Stored Procedure executor based on the selected stored procedure. The Stored Procedure executor does not appear on the Executors tab.

  1. In the pipeline canvas, click the Insert Stage icon or the Add Stage button.
  2. In the Stage Selector, click the Functions tab:
    The Stage Selector dialog box attempts to list all UDFs and stored procedures available to the role defined in the pipeline. To limit the results, you can specify a search string, or select a function type or schema.
    Since they are not supported, stored procedures that return tabular data do not display.
  3. Select the Snowflake stored procedure that you want to use.
    The pipeline canvas displays a Stored Procedure executor based on the selected stored procedure, providing a set of properties for every argument in the stored procedure.
  4. Verify that you selected the appropriate stored procedure.
    The executor provides the following information from the Snowflake stored procedure:
    • Name
    • Signature
    • Description, when available
    Note: You cannot change the stored procedure that the executor uses. If you selected the wrong stored procedure, delete the stage and add a new Stored Procedure executor.
  5. In the Arguments area, define the arguments for the executor.
    For each argument, define the following properties, as needed:
    Arguments Property Description
    Value Value to pass to the argument. The value must be a constant or treated as a constant.
    Treat as Constant Treats the specified value as a constant. Use when the specified value can otherwise be interpreted as a column name or Snowflake expression.
    To define an optional argument, define all arguments up to the optional argument.
    Important: Argument properties are listed in the order that they are defined in the stored procedure. To ensure that you define the properties appropriately, consult the stored procedure signature or definition.
  6. Remove any optional arguments that are not defined.