SQL Server - Merge

On this Page

Snap type:

Write

Description:

This Snap executes a SQL Merge with the given properties. The documents that are provided in the input view will be merged into the provided table on the provided database. Each document on the input view is expected to be merged or created with/as a new record in the table.

This Snap supports SQL Server 2008 or newer.

Merges will be batched up until the account's batch size property or until the structure of the update statement changes. An update statement will change if an incoming document contains different keys than a previous document.

The merge condition can only use variables, no constants or pipeline parameters.

A good example for a merge condition is SALARY =$SALARY (here we use the SALARY variable of the input document). A bad example for a merge condition is SALARY = '100000' (this will not work since we validate the provided columns in the condition against the types defined in the table schema).

While the expression toggle is available on the Merge Condition field, use of the expression toggle on the merge condition is not encouraged.

The bad example can be rewritten by using an upstream Mapper Snap, where '10000' is mapped to the SALARY variable, which then can be used in the merge condition as defined in a good example. The same applies for pipeline parameters, which need to be mapped upstream similarly using a Mapper Snap.

Expected upstream Snaps: The columns of the selected table need to be mapped upstream using a Mapper Snap. The Mapper Snap will provide the target schema,which reflects the schema of the table that is selected for the merge Snap.

Expected downstream Snaps: The Snap will output one document for every record merged, hence any document processing Snap can be used downstream.

Expected input: Document that conforms to the input view schema of the Snap. The input view schema is provided to an upstream Mapper Snap, based on the selected service object.

Expected output: Document which represents the status of the merge operation for that document. Each merge operation is represented as one document in the output view.

Prerequisites:

None

Support and limitations:

Ultra pipelines: Works in Ultra Pipelines.
Spark mode: Not supported in Spark mode.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See SQL Server Account for information on setting up this type of account.

Views:

Input	This Snap allows exactly one input view.
Output	This Snap has at most one output view. If an output view is available, then the original document that was used to create the statement will be output with the status of the merge executed.
Error	This Snap has at most one error view and produces zero or more documents in the view. Because the Snap must report what is reported by the database, the Snap sends all records to the error view and no record to the output view. If you want to see accurate results for each row you must set the batch size to 1 and execute the pipeline.

Settings

Label

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

The database schema name. In case it is not defined, then the suggestion for the Table Name will retrieve all table names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values.

The values can be passed using the pipeline parameters but not the upstream parameter.

Example: SYS
Default value: [None]

Table Name

Required. The table to execute the merge on.

The values can be passed using the pipeline parameters but not the upstream parameter.

Example: people

Default value: [None]

Number of retries

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

When you enable retry and a connection failure occurs that cannot be recovered by retry, the Snap writes a connection failure error in the error view. In some cases, the error view records might contain duplicate data that was written to the database. Ensure to verify all the records in the error file before you restart the merge request. You can locate the duplicate records in the error view by checking the $reason property for the sub-string: Connection is not available, request timed out.

Example: 3

Default value: 0

If the value is larger than 0, the Snap first downloads the target file into a temporary local file. If any error occurs during the download, the Snap waits for the time specified in the Retry interval and attempts to download the file again from the beginning. When the download is successful, the Snap streams the data from the temporary file to the downstream Pipeline. All temporary local files are deleted when they are no longer needed.
Ensure that the local drive has sufficient free disk space to store the temporary local file.

Retry interval (seconds)

Specifies the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception.

Example: 10

Default value: 1

When you enable retry and a connection failure occurs that cannot be recovered by retry, the Snap writes a connection failure error in the error view. In some cases, the error view records might contain duplicate data that was written to the database. Ensure to verify all the records in the error file before you restart the merge request. You can locate the duplicate records in the error view by checking the $reason property for the sub-string: Connection is not available, request timed out.

Merge condition

Required. The ON condition of the merge statement. A boolean-type expression is expected. See Merge Syntax for an explanation of merge syntax.

Default value: [None]

Identity column

Required. The table's identity column. If this is not set and the column is set to be generated always, then the merge will fail.

Default value: [None]

Enable identity insert

Select the check box 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 the check box, then the Snap strips any value that is meant for the identity column from the input document.

Default value: Not selected

Snap execution

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.

Examples

The following example illustrates the usage of SQL Merge Snap. In this example, we will supply two documents from upstream having customer information. We will try to merge this data into table called 'customer1'. One of the documents has the data of existing customer with an updated 'phoneno' field and other document is of new customer.

Following is the sample pipeline:

Input data is passed using the JSON Generator Snap. Following is the sample data passed:

The merge condition is applied on field 'customername' of customer1 table. Once the merge Snap execution completes, the record with customername 'John' updates its phoneno and a new record is created for customer 'Shaun'.

The sample output looks as shown below:

Release	Snap Pack Version	Date	Type	Updates
February 2024	436patches26177	24 Apr 2024	Latest	Fixed an issue with the SQL Server Snap Pack that displayed an error when numeric values with scale 0 were inserted into the database with DECIMAL or NUMERIC type columns, instead of inserting the value with decimal digits truncated. Fixed an issue with the SQL Server Snap Pack that displayed an error when fractional numeric values (numbers with a decimal point) were inserted into the database with an INT type column, instead of inserting the value with decimal digits truncated.
February 2024	436patches25757	03 Apr 2024	Latest	Fixed an issue with the SQL Server - Insert Snap that previously displayed an error when attempting to insert a true or false value into a `TinyInt` datatype. The Snap now correctly inserts 1 or 0 for true or false in the table, respectively.
February 2024	436patches25548	21 Mar 2024	Latest	Added support for XML and spatial types (Geography and Geometry) for SQL Server Snap Pack. Fixed an issue with the SQL Server - Insert Snap that displayed an error when an empty or blank string was passed as a value to an `integer-type` column. Behavior change: As part of the JOOQ upgrade done in `main25112`, the SQL Server-Insert Snap displayed the following error when an empty string was inserted to an integer-type column: `Caused by: java.lang.NumberFormatException: Character n is neither a decimal digit number, decimal point, nor "e" notation exponential mark` Now, the Snap inserts a null value in this scenario.
February 2024	main25112	14 Feb 2024	Stable	As of `main25112`, the SQL Server Snap Pack no longer supports the jDTS driver. If you are using the latest SQL Server driver versions (2014 and higher), we recommend you use the driver that is bundled with the SQL Server Snap Pack. Note that the older SQL Server versions are supported as is.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	434patches22758	11 Sep 2023	Latest	Fixed an issue with the SQL Server Stored Procedure and Table List Snaps that caused no retries to be executed even if you select the number of retries in the UI when a custom JDBC driver was used.
August 2023	434patches22579	22 Aug 2023	Latest	Improved the SQL Server Bulk Load Snap to reduce the chance of causing a deadlock error.
August 2023	main22460	16 Aug 2023	Stable	The SQL Server - Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.
May 2023	433patches22090	08 Aug 2023	Latest	The SQL Server Stored Procedure and SQL Server Table List Snaps now support the retry functionality.
May 2023	433patches21808	13 Jul 2023	Latest	The SQL Server Snap Pack is upgraded to the latest version of the Microsoft JDBC Driver 12.2.0.jre11 for SQL Server: Pipelines using the default JAR in the SQL server accounts might fail after the driver upgrade because the latest driver is backward-incompatible. To prevent your accounts from failing, reconfigure the URL properties field in account settings as follows: `trustServerCertificate = true` Pipelines NOT using the default driver (bundled with the SQL Server Snap Pack) will not fail. Note: This update will be a part of the stable distribution with the GA release on August 9, 2023. Learn more about the SQL Server driver upgrade: FAQ for Upgrading to SQL Server JDBC Driver 12.2.0 Fixed an issue with the SQL Server Insert Snap that was causing performance degradation between GA release 4.32 and 4.33 if the network connection between the Groundplex and the database server was slow.
May 2023	433patches21386	08 Jun 2023	-	The SQL Server Snap Pack is upgraded to the latest version of the Microsoft JDBC Driver 12.2.0.jre11 for SQL Server: Pipelines using the default JAR in the SQL server accounts might fail after the driver upgrade because the latest driver is backward-incompatible. To prevent your accounts from failing, reconfigure the URL properties field in account settings as follows: `trustServerCertificate = true` Pipelines NOT using the default driver (bundled with the SQL Server Snap Pack) will not fail. The Microsoft JDBC Driver `12.2.0.jre11` for SQL Server included in the SQL Server Snap Pack is currently NOT available with the latest distribution. However, you can still consume this patch through `433patches21386`. This update is scheduled to be included in the upcoming distribution release on July 12, 2023, and will be a part of the stable distribution with the GA release on August 9, 2023.
May 2023	433patches21119	15 May 2023	Latest	Updated the Bulk Load Snap to preserve empty strings as empty strings and null as nulls.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	431patches19263	19 Dec 2022	Latest	The SQL Server Insert Snap no longer no longer includes the Preserve case-sensitivity checkbox because the database is case-insensitive. The database stores the data regardless of whether the columns in the target table and the input data are in mixed, lower, or upper case.
November 2022	431patches19268	14 Dec 2022	Latest	The SQL Server-Insert Snap now displays the error, `Number overflow: <number>` (instead of `Batch operation failed`) when inserting a number into tinyinit column.
November 2022	431patches19234	09 Dec 2022	Latest	A memory leak in the SQL Server Stored Procedure Snap is fixed. The Snap now clears the closed connections from memory and retains the open connections.
November 2022	431patches19000	12 Nov 2022	Stable/Latest	The SQL Server accounts failed with a certificate error on Windows Snaplexes when using the default SQL driver with the `4.31 main18944` build. This patch addresses the certificate error issue.
November 2022	main18944	10 Nov 2022	Stable	The MySQL Insert Snap now creates the target table only from the table metadata of the second input view when the following conditions are met: The Create table if not present checkbox is selected. The target table does not exist. The table metadata is provided in the second input view.
August 2022	430patches17064	25 Aug 2022	Latest	The SQL Server - Select Snap now has the Convert rowversion datatype to integer checkbox to support the `ROWVERSION` data type. Select this checkbox to display the `ROWVERSION` data type as integers in the output.
4.30 Patch	430patches17368	19 Aug 2022	Latest	The SQL Server Execute Snap containing an explicit SQL transaction now works as expected when using a default JDBC driver.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29 Patch	429patches16235	21 Jul 2022	Latest	Fixed an issue with SQL Server Execute Snap where the Snap did not display a valid error message when the delete condition is invalid.
4.29	main15993	14 May 2022	Stable	Enhanced the SQL Server - Bulk Load Snap with the Batch Size field to process records in a batch.
4.28 Patch	428patches14649	25 Mar 2022	Latest	Enhanced the SQL Server - Select and SQL Server - Lookup Snaps with Option for Unique Identifier Column that allows you to convert the case to lower or upper while displaying the Unique Identifier output (display) value.
4.28	main14627	12 Feb 2022	Stable	Updated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the SQL Server Delete Snap.
4.27	main12833	13 Nov 2021	Stable	Enhanced the SQL Server - Execute Snap to invoke stored procedures.
4.26 Patch	426patches12535	05 Nov 2021	Latest	Fixed an issue in the SQL Server Bulk Load snap where boolean data type failed to load into BIT field.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25 Patch	425patches10797	23 Jul 2021	Latest	Fixed an issue with the SQL Server - Bulk Load Snap where the Snap fails when the login password contains a colon or a less than (<) symbol.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24 Patch	424patches8657	24 Mar 2021	Latest	Enhances the SQL Server - Select Snap by introducing a new field, Query Hints, which helps to customize and optimize the database engine to process query statements.
4.24	main8556	13 Feb 2021	Stable	Enhances the SQL Server - Select Snap to return only the selected output fields or columns in the output schema (second output view) using the Fetch Output Fields In Schema check box. If the Output Fields field is empty all the columns are visible. Enhances the SQL Server - Stored Procedure to accept parameters from input documents by column keys. If the values are empty, the parameters are populated based on the column keys for easier mapping in the upstream Mapper Snap.
4.23 Patch	423patches8190	20 Jan 2021	Latest	Fixes an issue with SQL Server - Execute to handle SQL statements that begin with special characters.
4.23	main7430	14 Nov 2020	Stable	Enhances the accounts in this Snap Pack to allow Windows-based (Active Directory) authentication and user impersonation for SQL Server user accounts.
4.22 Patch	422patches6728	17 Sep 2020	Latest	Enhances the SQL Server Snap pack to allow Windows (Active Directory) based authentication and user impersonation for SQL Server user accounts.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21 Patch	421patches6272	27 Jul 2020	Latest	Fixes the issue where Snowflake SCD2 Snap generates two output documents despite no changes to Cause-historization fields with DATE, TIME and TIMESTAMP Snowflake data types, and with Ignore unchanged rows field selected.
4.21 Patch	421patches6144	20 Jul 2020	Latest	Fixes the following issues with DB Snaps: The connection thread waits indefinitely causing the subsequent connection requests to become unresponsive. Connection leaks occur during Pipeline execution.
4.21 Patch	MULTIPLE8841	19 May 2020	Latest	Fixes the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends.
4.21 Patch	db/sqlserver8837	19 May 2020	Latest	Fixed the SQL Server - Stored Procedure Snap to support the UUID datatype.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20 Patch	db/sqlserver8793	07 Apr 2020	Latest	Fixed an issue in the SQL Server - Insert Snap due to which the Snap failed to load values of data type INT.
4.20 Patch	db/sqlserver8796	10 Apr 2020	Latest	Fixed the SQL Server - Bulk Load Snap to mask the password in the logged exception messages.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19 Patch	db/sqlserver8413	13 Dec 2019	Latest	Fixed an issue with the SQL Server - Update Snap wherein the Snap is unable to perform operations when: An expression is used in the Update condition property. Input data contain the character '?'.
4.19	snaprsmrc528	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18 Patch	db/sqlserver7989	07 Oct 2019	Latest	Fixed an issue in the SQL Server - Merge Snap wherein identity columns are not handled correctly. Also, added a field, Enable Identity Insert, that enables you to insert values into an identity column.
4.18	snapsmrc523	10 Aug 2019	Stable	Added support for SQL Server account Active Directory authentication for SQL server for driver JAR version `mssql-jdbc-6.2.2-jre8.jar`. Reverts a 4.17-patch (db/sqlserver7394) update regarding how BIT and BOOLEAN column data type values are displayed. They now display as true or false (4.17 GA behavior in snapsmrc515) rather than converting to 0 or 1 values (4.17-patch behavior).
4.17 Patch	MULTIPLE7479	18 Jul 2019	Latest	Fixed an issue with the SQL Server - Lookup Snap wherein it fails a UUID search.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Fixed an issue with the SQL Server Execute Snap wherein the Snap would send the input document to the output view even if the Pass through field is not selected in the Snap configuration. With this fix, the Snap sends the input document to the output view, under the key original, only if you select the Pass through field. Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16 Patch	db/sqlserver6981	20 Mar 2019	Latest	Fixed an issue of slow performance in SQL Server Snaps while using SQL Server Dynamic account type.
4.16 Patch	db/sqlserver6818	22 Feb 2019	Latest	Fixed an issue with the Lookup Snap passing data simultaneously to output and error views when some values contained spaces at the end.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15 Patch	db/sqlserver6337	05 Dec 2018	Latest	Replaced Max idle time and Idle connection test period properties with Max life time and Idle Timeout properties respectively, in the Account configuration. The new properties fix the connection release issues that were occurring due to default/restricted DB Account settings.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14 Patch	db/sqlserver5912	03 Oct 2018	Latest	Fixed an issue to parse the right data type and display it in the input schema for SQL Server Snap..
4.14 Patch	db/sqlserver5665	13 Aug 2018	Latest	Implemented a connection retry logic in the SQL Server account to resolve the connection loss issue in a customer's org.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.12	snapsmrc480	17 Feb 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.11 Patch	db/sqlserver4388	08 Dec 2017	Latest	Fixed an issue with the Stored Procedure Snap that does not maintain the columns' order on the output as per table's definition.
4.11 Patch	db/sqlserver4288	18 Nov 2017	Latest	SQL Server Snap Pack - Fixed an issue when inserting a valid NaN value into a column.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.10 Patch	sqlserver3953	21 Sep 2017	Latest	Fixed an issue where the SQL Server Stored Procedure gets hanged when more than one Snap existed in the pipeline each processing greater than 1K documents.
4.10	snapsmrc414	12 Aug 2017	Stable	Added Auto commit property to the Select and Execute Snaps at the Snap level to support overriding of the Auto commit property at the Account level.
4.9.0 Patch	sqlserver3224	06 Jul 2017	Latest	Addressed an issue with SQL Server - Bulk Load execution even with 0 input documents
4.9.0 Patch	sqlserver3076	01 Jun 2017	Latest	Fixed an issue regarding connection not closed after login failure; Expose autocommit for "Select into" statement in PostgreSQL Execute Snap and Redshift Execute Snap
4.9	snapsmrc405	13 May 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.8.0 Patch	sqlserver2803	10 Apr 2017	Latest	Addressed an issue with slow performance with Bulk Load BCP.
4.8.0 Patch	sqlserver2761	27 Mar 2017	Latest	Potential fix for JDBC deadlock issue.
4.8.0 Patch	sqlserver2706	27 Feb 2017	Latest	Fixed SQL Server Snap Pack rendering dates that are one hour off from the date returned by database query for non-UTC Snaplexes.
4.8	snapsmrc398	11 Feb 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.7	snapsmrc382	23 Nov 2016	Stable	Extended support for SQL Server Dynamic accounts. Updated the SQL Server Stored Procedure Snap with the Pass through field.
4.6	snapsmrc362	13 Aug 2016	Stable	Resolved an issue in SQL Server Bulk Load Snap that caused BCP program related failures. Enhanced to fully support SQL statements with/without expressions & SQL bind variables. Resolved an issue that caused failures when executing merge statements.
4.5.1	snapsmrc344	18 May 2016	Latest	Upgraded with the latest SnapLogic Platform release.
4.5	snapsmrc344	18 May 2016	Stable	Resolved an issue in SQL Server Execute Snap that erroneously reported a database/schema mismatch during Snap/pipeline execution. Resolved an issue in SQL Server Lookup Snap that occurred when handling case-insensitive field values.
4.4.1	NA	18 Mar 2016	Latest	Introduced the SQL Bulk Load in this release.

SQL Server - Merge

Settings

Examples

See Also