Skip to end of metadata
Go to start of metadata

Introduction

A Snowflake Invoke Stored Procedure activity lets you take advantage of Snowflake's extended features and provides the ability to use stored procedures created in Snowflake as a target in an operation. Information on Snowflake stored procedures is available from Snowflake at Stored Procedures and Stored Procedure Management & Usage. After configuring a Snowflake connection, you can configure as many Snowflake activities as you like for each Snowflake connection.

Creating a Snowflake Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the Snowflake connection block to display activities that are available to be used with a Snowflake connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Snowflake activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a Snowflake Invoke Stored Procedure Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Snowflake Invoke Stored Procedure Activity

Follow these steps to configure a Snowflake Invoke Stored Procedure activity:

  • Step 1 – Select a Stored Procedure
  • Step 2 – Review Data Schema

Step 1 – Select a Stored Procedure

Step 1

  • Name: Enter a name to use to identify the Snowflake Invoke Stored Procedure activity. The name must be unique for each Invoke Stored Procedure activity and must not contain forward slashes (/) or colons (:).

  • Select a Stored Procedure: This section displays the stored procedures available in the Snowflake endpoint. When reopening an existing activity configuration, only the selected stored procedure is displayed instead of reloading the entire stored procedure list.

    • Selected Stored Procedure: After a stored procedure is selected, it will be listed here.
    • Search: Enter any part of the stored procedure name into the search box to filter the list of stored procedures. The search is not case-sensitive. If the stored procedures are already displayed in the list, the results will be filtered in real time with each keystroke. To reload stored procedures from the endpoint when searching, enter search criteria and then refresh, as described below.
    • Refresh: Click the refresh icon Refresh icon or the word Refresh to reload stored procedures from the Snowflake endpoint. This may be useful if you have recently added stored procedures to the Snowflake instance. This action refreshes all metadata used to build the list of stored procedures displayed in the configuration.
    • Selected Stored Procedure: Within the list, click anywhere on a row to select a stored procedure. Only one stored procedure can be selected. The information available for each stored procedure is fetched from the Snowflake endpoint:
      • Name: The stored procedure name from Snowflake.
      • Type: The stored procedure type from Snowflake.

    TIP: If the list does not populate with available stored procedures, the Snowflake connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The
    configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2 – Review Data Schema

Step 2 Review Data Schema

  • Data Schema: The request and response data schemas will be displayed. If provided during activity configuration, the request and/or response data schemas are displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more. You can also define schemas directly in a transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click Discard Changes to close the configuration without saving without saving changes to this step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a Snowflake Invoke Stored Procedure activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Snowflake Invoke Stored Procedure activities can be used as a target with these operation patterns:

Other patterns are not valid using Snowflake Invoke Stored Procedure activities. See the validation patterns on the Operation Validity page.

An example of using the activity in an operation: Example

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.

On This Page

Last updated:  Jan 15, 2020

  • No labels