On this Page
Table of Contents | ||||
---|---|---|---|---|
|
Default value: [None]
Snap type: | Write | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description: | This Snap executes a SQL update with the given properties. Keys from the document will be used as the columns to update and their values will be the updated value in the column. | |||||||||||||||
Prerequisites: | [None] | |||||||||||||||
Support and limitations: |
| |||||||||||||||
Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See MySQL Account for information on setting up this type of account. | |||||||||||||||
Views: |
| |||||||||||||||
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 tables names of all schemas. The property is suggestable and will retrieve available database schemas during suggest values.
Example: SYS | |||||||||||||||
Table name | Required. The name of the table to execute the update operation on.
Example: people Default value: [None] | |||||||||||||||
Update condition | Required. 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:
Examples: Without using expressions
Using expressions
| |||||||||||||||
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. Example: 3 Default value: 0
| |||||||||||||||
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 | |||||||||||||||
|
|
Example
In this example, we will use the well-known Northwind sample database.
Following is a selection from the "Customers" table:
CustomerID | CustomerName | ContactName | Address | City | PostalCode | Country |
---|---|---|---|---|---|---|
1 | Alfreds Futterkiste | Maria Anders | Obere Str. 57 | Berlin | 12209 | Germany |
2 | Ana Trujillo Emparedados y helados | Ana Trujillo | Avda. de la Constitución 2222 | México D.F. | 05021 | Mexico |
3 | Antonio Moreno Taquería | Antonio Moreno | Mataderos 2312 | México D.F. | 05023 | Mexico |
4 | Around the Horn | Thomas Hardy | 120 Hanover Sq. | London | WA1 1DP | UK |
5 | Berglunds snabbköp | Christina Berglund | Berguvsvägen 8 | Luleå | S-958 22 | Sweden |
Assume we wish to update the customer "Alfreds Futterkiste" with a new contact person and city.
Enter Customers in the Table name property and CustomerName='Alfreds Futterkiste' in the Update condition property.
Assume that the Update Snap receives a Map data in the input view as following:
Code Block |
---|
{ "ContactName" : "Alfred Schmidt", "City" : "Hamburg" } |
When you save and execute the pipeline, the Snap internally formats a standard SQL UPDATE statement as following:
UPDATE Customers
SET ContactName='Alfred Schmidt', City='Hamburg'
WHERE CustomerName='Alfreds Futterkiste';
and submit the request to the database server.
The selection from the "Customers" table will now look like this:
CustomerID | CustomerName | ContactName | Address | City | PostalCode | Country |
---|---|---|---|---|---|---|
1 | Alfreds Futterkiste | Alfred Schmidt | Obere Str. 57 | Hamburg | 12209 | Germany |
2 | Ana Trujillo Emparedados y helados | Ana Trujillo | Avda. de la Constitución 2222 | México D.F. | 05021 | Mexico |
3 | Antonio Moreno Taquería | Antonio Moreno | Mataderos 2312 | México D.F. | 05023 | Mexico |
4 | Around the Horn | Thomas Hardy | 120 Hanover Sq. | London | WA1 1DP | UK |
5 | Berglunds snabbköp | Christina Berglund | Berguvsvägen 8 | Luleå | S-958 22 | Sweden |
Be careful when updating records. If we had omitted the Update condition property, in the example above, the "Customers" table would have looked like this:
CustomerID | CustomerName | ContactName | Address | City | PostalCode | Country |
---|---|---|---|---|---|---|
1 | Alfreds Futterkiste | Alfred Schmidt | Obere Str. 57 | Hamburg | 12209 | Germany |
2 | Ana Trujillo Emparedados y helados | Alfred Schmidt | Avda. de la Constitución 2222 | Hamburg | 05021 | Mexico |
3 | Antonio Moreno Taquería | Alfred Schmidt | Mataderos 2312 | Hamburg | 05023 | Mexico |
4 | Around the Horn | Alfred Schmidt | 120 Hanover Sq. | Hamburg | WA1 1DP | UK |
5 | Berglunds snabbköp | Alfred Schmidt | Berguvsvägen 8 | Hamburg | S-958 22 | Sweden |
Example
In this pipeline, the MySQL Update Snap, updates the record in a table.
The CSV Generator Snap passes the values to be updated to a record on the MySQl Database table. The value for command is set to 2.
The Mapper Snap maps the record PersonID to be updated.
The MySQL Snap updates the table, `pqadb`.`TAM_SAMPLE_PERSONS`. Give an update condition if a specific record needs to be updated only after fulfilling the given condition.
The successful execution of the pipeline displays the below output preview:
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|