Azure Synapse SQL - Table List

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

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

Field Name

Field Type

Description

Label*

Default Value: Azure Synapse SQL - Table List
ExampleList 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 ValueValidate & 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 the Azure Synapse database and list the tables.

Configure the Azure Synapse SQL with the dbo Schema Name from where you want to read the tables:

On validation, the Snap generates the list of tables as follows:

Download this Pipeline

Downloads

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts, as applicable.

  3. Provide Pipeline parameters, as applicable.

 

  File Modified

File Example_AzureSynapseSql - TableList.slp

Jul 26, 2022 by Kalpana Malladi

Snap Pack History


Related Content