...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Overview
You can use this Snap to insert new records into database tables. The Snap executes a 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 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
| Multiexcerpt include macro | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| The second input 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
| Info |
|---|
|
): Indicates a list that is dynamically populated based on the configuration.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: Deselected | Checkbox | Select this checkbox to create the target table if it does not exist.
| ||
Preserve case sensitivity Default Value: Deselected | 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: Deselected | 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: Deselected | 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:
|
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.
...
| Note |
|---|
The 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. |
Examples
Inserting Records by Creating a New Table
This example Pipeline demonstrates how to insert data into a table. The table 'employee1' does not exist on database initially. So the Snap first creates the table 'Employee1' and then inserts the records read and parsed using the upstream Snaps.
...
Here is the sample output of the Snap.
Downloads
| Info |
|---|
|
| Attachments | ||||
|---|---|---|---|---|
|
Snap Pack History
| Multiexcerpt include macro | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
Related
...
Content
...