Azure Synapse SQL Stored Procedure

Overview

You can use this Snap to execute stored procedures in the Azure Synapse SQL Database.


Azure Synapse SQL Stored Procedure Snap Overview

Prerequisites

Limitations

None.

Known issues

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

Optional.A document containing parameters for the stored procedure.
Output #1

Document containing the status of the stored procedure execution.
Output #2

Document containing the result set returned by the stored procedure.
Learn more about Error handling.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field/Field set Description
Label

String

Required.Specify a unique name for the Snap.

Default value: Azure Synapse SQL - Stored Procedure

Example: Azure Synapse SQL - Stored Procedure
Schema Name

String/Expression/ Suggestion

Specify the schema name of the database where the Stored Procedure resides.

Default value: N/A

Example: dbo
Package Name

String/Expression/ Suggestion

Specify the package name that contains the Stored Procedures.

Default value: N/A

Example: snapdedicatedsql
Stored Procedure Name

String/Expression/ Suggestion

Specify the Stored Procedure name to execute. If a package is defined, then it will only return the procedures of that package. If a schema is defined and no package is defined, then the Snap returns all procedures of that schema.

Default value: N/A

Example: SelectAllEmployee
Parameter Values
Parameter Value

String/Expression

Use this field set to specify advanced parameters that you want to include in the request. Select the input parameter values for the stored procedure. The parameter values are bound to the input columns in the order they appear in the list. Therefore, you must define the values in the same order as they appear in the Stored Procedure definition.

For example, a stored procedure named createGreeting has three parameters p1, p2, and p3. p1 and p2 input parameters are of type VARCHAR2. Then you need to provide two string values. The first value goes to p1 and the second to p2.

Note: Do not use quotation marks when setting input parameters unless they are part of the input value itself, because they are treated as escaped plain characters. For example, if the desired input value is TEST_VALUE1, set the input parameter as TEST_VALUE1, if you set it as "TEST_VALUE1", it is recognized as \"TEST_VALUE1\".

Default value: None

Example: TEST_VALUE1

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Example: Validate & execute