Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

...

You can use this Snap to insert new records into database tables. The Snap executes a SQL Insert statement with given the specified values. Document keys  Key-value pairs are used as the columns to insert into, columns and their respective values are into the values insertedtable columns. Missing columns from the document insert null values into them.

...

Multiexcerpt include macro
nameAzure_Synapse_SQL_Driver_Limitation
templateData[]
page[Beta Documentation] Azure Synapse SQL - Bulk Load
addpanelfalse

Known Issues

...

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 1

  • Max: 2

  • Mapper

  • JSON Generator

  • CSV Parser

This Snap can at the most have two document input views. 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

  • Min: 0

  • Max: 1

  • JSON Generator

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:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the 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.

...

Field Name

Field Type

Description

Label*

Default Value: Azure Synapse SQL - Insert
ExampleAzure_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
Example: dbo

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
Example: dbo.people

String/Expression

Specify the name of a table to which the records are to be inserted.

Create table if not present

Default ValueNot selected
Example: SelectedDeselected

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 Unable to create table:"<table_name>" error due to 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).

Info

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 ValueNot selected
Example: SelectedDeselected

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 ValueNot selected
Example: SelectedDeselected

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 Value1
Example: 10

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 ValueNot selected
Example: SelectedDeselected

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
Example: Validate & Execute

Dropdown list

Select 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.

...

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.

Troubleshooting

...

Error

...

Reason

...

Resolution

...

Account validation failed.

...

The Pipeline ended before the batch could complete execution due to a connection error.

...

.

...

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 upstream.

...

First read the data that you want to insert with a File Reader Snap:

...

Multiexcerpt include macro
nameAzure_Synapse_SQL_SPH
templateData[]
addPaneltrue
page[Beta Documentation] Azure Synapse SQL Snap Pack

...