In this article

Overview

You can use this Snap to read data from Azure Synapse SQL and list tables.

Snap Type

The Azure Synapse SQL - Table List Snap is a READ-type Snap.

Prerequisites

A valid Azure Synapse Account with the required permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Input

Document

Min: 0
Max: 1

Mapper
Copy

Output

Document

Min: 1
Max: 1

JSON Formatter

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the field set.
Remove icon ( ): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default Value: Azure Synapse SQL - Table List
Example: List Employee Tables

String

Specify a unique name for the Snap.

Schema Name

Default Value: N/A
Example: dbo

String/Expression

Specify the database schema name.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Select one of the following three modes in which the Snap executes:

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.

Example

Listing Tables from Azure Synapse SQL

This example Pipeline demonstrates how to read data from Azure Synapse database and list the tables.

First, configure the Azure Synapse SQL with the dbo Schema Name from where you want to read the tables.

Upon validation, the Snap generates the list of tables as follows.

Download this Pipeline.

Downloads

Download and import the Pipeline into SnapLogic.
Configure Snap accounts, as applicable.
Provide Pipeline parameters, as applicable.

	File	Modified

No files shared here yet.

Azure Synapse SQL Snap Pack

Release	Snap Pack Version	Date	Type	Updates
August 2024	main27765	21 Aug 2024	Stable	Upgraded the `org.json.json` library from v20090211 to v20240303, which is fully backward compatible.
May 2024	437patches26597	03 Jun 2024	Latest	Fixed an issue with the Azure Synapse SQL Select Snap that displayed an error and did not retry the connection when the serverless SQL pool was warming up.
May 2024	main26341	08 May 2024	Stable	The following Azure Synapse SQL Active Directory Account has been renamed because Microsoft has rebranded Azure Active Directory to Microsoft Entra ID. Azure Synapse SQL Active Directory Account → Azure Synapse SQL Entra Account Updated the Delete Condition (Truncates a Table if empty) field in the Azure Synapse SQL Delete Snap to Delete condition (deletes all records from a table if left blank) to indicate that all entries will be deleted from the table when this field is blank, but no truncate operation is performed.
February 2024	436patches25597	27 Mar 2024	-	Upgraded the jOOQ library of the Azure Synapse SQL Snap Pack from v3.9.1 to v3.17.x. This upgrade is currently NOT available with the latest distribution. However, you can still consume this patch through `436patches25597`. This update is scheduled to be included in the latest distribution release on April 10, 2024, and will be a part of the stable distribution with the GA release on May 8. 2024. Behavior change: The jOOQ library upgrade for Azure Synapse SQL Snap Pack, done as part of the `436patches25597`, resulted in the following behavior change: Previously, when `“null”(string)` was passed from the upstream Mapper Snap for the Bigint datatype, the /wiki/spaces/DRWIP/pages/3011674578Snap updated it as `null` without displaying any error. It displayed the status as `0` and the output message as `Success`. Now, the Snap displays the following error in this scenario: `Error converting value(expecting a number but you are sending String(“null”))` If you pass `null` from Mapper Snap with the expression enabled, the Snap updates the `null` value for the BigInt datatype correctly, as earlier.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	The Azure Synapse SQL - Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.
May 2023	433patches21718	03 Jul 2023	Latest	Fixed an issue with the Azure Synapse SQL Bulkload Snap that caused a `404 error` when the External Location was set to ADLS Gen2 and the Azure Folder field was not specified in the account settings.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	432patches20389	12 Apr 2023	Latest	The Azure Synapse SQL Account and Azure Synapse SQL Active Directory Account now support the latest JDBC Driver 12.2.0.jre11 by default. You do not have to upload the JAR file in the JDBC Driver field manually.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	431patches19493	12 Jan 2023	Latest	The Azure Synapse SQL - Bulk Load Snap no longer fails when loading the JDBC driver from SLDB as it now uses the uploaded JAR driver when performing all bulk load operations.
November 2022	431patches19410	06 Jan 2023	Stable	Fixed the Azure SQL - Execute Snap using the Azure SQL Active Directory Account that failed with `SQL operation failed` errors in environments using federated authentication
November 2022	431patches19410	29 Dec 2022	Latest	Fixed the Azure SQL - Execute Snap using the Azure SQL Active Directory Account that failed with `SQL operation failed` errors in environments using federated authentication
November 2022	431patches19354	02 Jan 2023	Latest	The Azure Synapse SQL - Bulk Load Snap no longer fails with the error `Invalid column value in CSV data file` when the data contains the field quote character (").
November 2022	431patches19263	19 Dec 2022	Latest	The Azure Synapse SQL Insert Snap no longer supports the Preserve Case Sensitivity checkbox.
November 2022	main18944	10 Nov 2022	Stable	Introduced the Azure Synapse SQL Snap Pack. The Azure Synapse Analytics is service from Microsoft that helps you query data to create, update, insert, or delete data in the Azure Synapse SQL. This Snap Pack contains the following Snaps: Azure Synapse SQL Bulk Load Azure Synapse SQL Delete Azure Synapse SQL Execute Azure Synapse SQL Insert Azure Synapse SQL Select Azure Synapse SQL Stored Procedure Azure Synapse SQL Table List Azure Synapse SQL Update

Azure Synapse SQL Table List