In this article
Overview
You can use this Snap to insert new records into database tables. The Snap executes a SQL Insert statement with given values. Document keys are used as the columns to insert into, and their values are the values inserted. Missing columns from the document insert null values into them.
Snap Type
Azure Synapse SQL Insert Snap is a WRITE-type Snap that inserts new records in a SQL database table.
Prerequisites
Valid client ID.
A valid database account with the required permissions.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
None.
Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| This Snap can at the most have two document input views. The second view can be added to use the metadata of the source table as a document so that the table is created in SQL with a similar schema as the source table. The metadata is not used if the table already exists. |
Output | Document |
|
| The Snap outputs one document for every record written, hence any document processing Snap can be used downstream. If an output view is available, then the original document that was used to create the statement is written to the output with the status of the insert executed. |
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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
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 whether 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 fieldset.
Remove icon (): Indicates that you can remove fields from the fieldset.
Field Name | Field Type | Description |
---|---|---|
Label* Default Value: Azure Synapse SQL - Insert | String | 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. |
Schema Name Default Value: None | String/Expression | Specify the database schema name. In case 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. |
Table Name* Default Value: None | String/Expression | Specify the name of a table to which the records are to be inserted. |
Create table if not present Default Value: Not selected | Checkbox | Select this checkbox to create the target table if it does not exist.
Due to implementation details, a newly created table is not visible to subsequent database Snaps during runtime validation. If you wish to immediately use the newly updated data you must use a child Pipeline that is invoked through a Pipeline Execute Snap. |
Preserve case sensitivity Default Value: Not selected | Checkbox | Select this check box to specify whether the letter case used in column labels must be preserved while performing the insert operation. Selecting this option ensures that the precise cases used are retained. |
Number of Retries Default Value: Not selected | 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. |
Retry Interval (seconds) Default Value: 1 | String/Expression | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. |
Enable identity insert Default Value: Not selected | 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. |
Snap Execution Default Value: | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Account validation failed. | The Pipeline ended before the batch could complete execution due to a connection error. | Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open. |
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:
<screenshot of Pipeline/Snap and description>
Download this Pipeline.
Downloads
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
Snap Pack History
Macro lookup error: excerpt "XYZ Snap Pack History" was not found on page "Azure Synapse SQL Snap Pack" (with ID 2538668115) in space "SD".
If you're experiencing issues please see our Troubleshooting Guide.