Azure Synapse SQL Insert

Overview

You can use this Snap to insert new records into database tables. The Snap executes an SQL Insert statement with the specified values. Key-value pairs are used to insert columns and their respective values into the table columns. Missing columns from the document results in inserting null values into them.

This is a Write-type Snap.
Works in Ultra Tasks

Prerequisites

Valid client ID.
A valid Azure Synapse SQL Account with the required permissions.

Limitations

None.

Known issues

None.

Snap views


Type	Description	Examples of upstream and downstream Snaps
Input	A document containing the data to be inserted into the table.	Mapper JSON Parser CSV Parser
Output	Document containing the number of records inserted.	Mapper JSON Formatter
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 the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline. Default value: Azure Synapse SQL - Insert Example: `Azure_Synapse_SQL_Insert`
Schema Name `String/Expression`	Specify the database schema name. If it is not defined, then the suggestion for the Table Name will retrieve all tables names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values. Default value: None Example: `dbo`
Table Name `String/Expression`	Required.Specify the name of a table to which the records are to be inserted. Default value: None Example: `dbo.people`
Create table if not present `Checkbox`	Select this checkbox to create the target table if it does not exist: If a second input view is configured for the Snap and it contains a document with schema (metadata) of the source table, the Snap creates the new (target) table using the same schema (metadata). However, if the schema comes from a different database, the Snap might fail with the `Unable to create table:"<table_name>"` error because of data type incompatibility. In the absence of a second input view (the schema/metadata document), the Snap creates a table based on the data types of the columns generated from the first row of the input document (first input view). Because of implementation details, a newly created table is not visible to subsequent database Snaps during runtime validation. If you must immediately use the newly updated data, use a child Pipeline that you invoke through a Pipeline Execute Snap. Default value: Deselected
Number of Retries `String/Expression`	Specify the maximum number of attempts to be made to receive a response. The request is terminated if the attempts do not result in a response. Default value: 0 Example: `3`
Retry Interval (seconds) `String/Expression`	Specify the time period between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. Default value: 1 Example: `10`
Enable identity insert `Checkbox`	Select this checkbox to insert values from the input document into the target table identity column. Ensure that the target table contains an identity column. If you do not select this checkbox, then do not enter any value for the identity column in the input document. Default value: Deselected
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`

Table Creation

If the table does not exist when the Snap tries to do the insert, and the Create table if not present field is selected, a new table is created with the columns and data types required to hold the values in the first input document. If you would like the table to be created with the same schema as a source table, you can connect the second output view of a Select Snap to the second input view of this Snap. The extra view in the Select and Bulk Load Snaps are used to pass metadata about the table, effectively allowing you to replicate a table from one database to another.

The table metadata document that is read in by the second input view contains a dump of the JDBC DatabaseMetaData class. The document can be manipulated to affect the CREATE TABLE statement that is generated by this Snap. For example, to rename the name column to full_name, you can use a Mapper Snap that sets the path $.columns.name.COLUMN_NAME to full_name. The document contains the following fields:

columns - Contains the result of the getColumns() method with each column as a separate field in the object. Changing the COLUMN_NAME value will change the name of the column in the created table. Note that if you change a column name, you do not need to change the name of the field in the row input documents. The Snap will automatically translate from the original name to the new name. For example, when changing from name to full_name, the name field in the input document is put into the full_name column. You can also drop a column by setting the COLUMN_NAME value to null or the empty string. The other fields of interest in the column definition are:
- TYPE_NAME - The type to use for the column. If this type is not known to the database, the DATA_TYPE field is used as a fallback. If you want to explicitly set a type for a column, set the DATA_TYPE field.
- _SL_PRECISION - Contains the result of the getPrecision() method. This field is used with the _SL_SCALE field for setting the precision and scale of a DECIMAL or NUMERIC field.
- _SL_SCALE - Contains the result of the getScale() method. This field is used with the _SL_PRECISION field for setting the precision and scale of a DECIMAL or NUMERIC field.
primaryKeyColumns - Contains the result of the getPrimaryKeys() method with each column as a separate field in the object.
declaration - Contains the result of the getTables() method for this table. The values in this object are just informational. The target table name is taken from the Snap property.
importedKeys - Contains the foreign key information from the getImportedKeys() method. The generated CREATE TABLE statement will include FOREIGN KEY constraints based on the contents of this object. Note that you will need to change the PKTABLE_NAME value if you changed the name of the referenced table when replicating it.
indexInfo - Contains the result of the getIndexInfo() method for this table with each index as a separated field in the object. Any UNIQUE indexes in here will be included in the CREATE TABLE statement generated by this Snap.

This Snap will not automatically fix some errors encountered during table creation because it requires user intervention to resolve correctly. For example, if the source table contains a column with a type that does not have a direct mapping in the target database, the Snap fails to execute. You then need to add a Mapper Snap to change the metadata document to explicitly set the values needed to produce a valid "CREATE TABLE" statement.