...
Snap type:
Write
...
Description:
...
In this article
Table of Contents | ||||
---|---|---|---|---|
|
Overview
You can use this Snap to execute a SQL UPDATE statement for each batch of input documents. Keys from the document
...
are used as the columns to update and their values will be the updated value in the column.
...
Info |
---|
Updates 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. |
This Snap also supports DML (Data Manipulation Language) operations (ALTER and INSERT) when using the AWS Athena database.
Snap Type
Generic JDBC - Update is a Write-type Snap that executes SQL UPDATE statement.
Prerequisites
...
...
None
...
.
Support
...
- Ultra pipelines: Supported in Ultra Pipelines.
- Spark mode: Not supported in Spark mode.
...
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See JDBC Account for information on setting up this type of account.
...
for Ultra Pipelines
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. This operation is not supported for Apache Hive databases.
Known Issues & Limitations
None.
Snap Views
...
Settings
Label
...
Type | Format | Number of views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| This Snap has exactly one document input view. |
Output | Document |
|
| This Snap has at most one document 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 update. |
Error |
...
This Snap has at most one document error view and produces zero or more documents in the view.
Note: Database write Snaps output all records of a batch (as configured in your account settings) to the error view if the write fails during batch processing.
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 |
---|
|
Field Name | Field Type | Description |
---|---|---|
Label* Default Value: Generic JDBC - Update | 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: N/A | 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. |
...
The values can be passed using the pipeline parameters but not the upstream parameter. |
Table Name* Default Value: N/A |
...
Employee | String/Expression | Specify the name of the table |
...
in the instance. The table name is suggestible and requires an account setting. The values can be passed using the pipeline parameters but not the upstream parameter. |
Update Condition Default Value: N/A |
...
Default value: [None]
...
Required. SQL where clause of the update statement.
Example: email = "customer@example.com"
Default value: [None]
...
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Without using expressions
Using expressions
| String/Expression | Specify the SQL WHERE clause of the update statement. You can define specific values or columns to update (Set condition) in the upstream Snap, such as Mapper Snap, and then use the WHERE clause to apply these conditions on the columns sourced from the upstream Snap. For instance, here is a sample of an Update SQL query: If the Update Condition field is left blank, the condition is applied on all the records of the target table. Refer to the example to understand how to use the Update Condition. | ||
Number of retries Default Value: 0 | Integer/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 | Integer/Expression | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. | ||
Snap Execution Default Value: Execute only | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Examples
Update data in an SQL database
This example pipeline demonstrates how to update the data in the SQL database.
...
Step 1: Configure the Mapper Snap to pass the data. On validation, the Snap displays the output based on the specified input.
Step 2: Configure the Generic JDBC - Update Snap to update the “TECTONIC”.”ACTRESS1” table with the update condition. On validation, the Snap displays a confirmation message indicating that the data was successfully updated in the database.
Downloads
Info |
---|
|
Attachments | ||||
---|---|---|---|---|
|
Snap Pack History
Expand | |||
---|---|---|---|
|
...
|
...
Note |
---|
This operation is not supported for Apache Hive databases. |
...
|
...
Related Content
...