Snap type:
Read
Description:
JSON paths can be used in a query and will have values from an incoming document substituted into the query. However, documents missing values for a given JSON path will be written to the Snap's error view. After a query is executed, the query's results are merged into the incoming document, overwriting any existing keys' values. The original document is output if there are no results from the query.
Queries produced by the Snap have the format:
Code Block |
---|
SELECT * FROM [table] WHERE [where clause] ORDER BY [ordering] LIMIT [limit] OFFSET [offset] |
If more powerful functionality is desired, then the Execute Snap should be used.
N/A
Works in Ultra Task Pipelines.
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Vertica Accounts for information on setting up this type of account.
This Snap has at most one 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. |
Settings
Label
Schema name
Required. The database schema name. Selecting a schema filters the Table name list to show only those tables within the selected schema. The property is suggestible and retrieves available database schemas during suggest values.
Example: public
Table name
Required. The table on which to execute the insert operation.
Example: emp
Where clause
The WHERE clause of the SELECT statement. This supports document value substitution (for example, $person.firstname will be substituted with the value found in the incoming document at the path).
Examples:
Multiexcerpt include macro name ME_DB_Snaps_Query_Examples page Oracle - Update
Order by
Enter the columns in the order in which you want them set up. The default database sort order will be used.
Example: name, email
Limit offset
The starting row of the query.
Example: 0
Limit rows
The number of rows to return from the query.
Example: 10
Output fields
Enter or select output field names for SQL SELECT statement. To select all fields, leave it at default.
Example: email, address, first, last
Default value: Not selected
If selected, the input document will be passed through to the output view under the key 'original'.
Default value: Selected
If selected, no document will be written to the output view when a SELECT operation does not produce any result. If this property is not selected and the Pass through property is selected, the input document will be passed through to the output view.
Default value: Not selected
Select one of the options for this property to override the state of the Auto commit property on the account. The Auto commit at the Snap-level has three values: True, False, and Use account setting. The expected functionality for these modes are:
- True - The Snap will execute with auto-commit enabled regardless of the value set for Auto commit in the Account used by the Snap.
- False - The Snap will execute with auto-commit disabled regardless of the value set for Auto commit in the Account used by the Snap.
- Use account setting - The Snap will execute with Auto commit property value inherited by the Account used by the Snap.
Default value: False
Conditional. This property applies only when the Output fields property is provided with any field value(s).
If this property is selected, the Snap tries to match the output data types same as when the Output fields property is empty (SELECT * FROM ...). The output preview would be in the same format as the one when SELECT * FROM is implied and all the contents of the table are displayed.
Default value: Not selectedSnap type: | Read | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description: | This Snap enables you to fetch data from a database by providing a table name and configuring the connection. The Snap produces the records from the database on its output view, which can then be processed by a downstream Snap.
If more powerful functionality is desired, then the Execute Snap should be used. | ||||||||||||
Prerequisites: | N/A | ||||||||||||
Support and limitations: | Works in Ultra Task Pipelines. | ||||||||||||
Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Vertica Accounts 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 | Required. The database schema name. Selecting a schema filters the Table name list to show only those tables within the selected schema. The property is suggestible and retrieves available database schemas during suggest values. Example: public | ||||||||||||
Table name | Required. The table on which to execute the insert operation. Example: emp | ||||||||||||
Where clause | The WHERE clause of the SELECT statement. This supports document value substitution (for example, $person.firstname will be substituted with the value found in the incoming document at the path). Examples:
| ||||||||||||
Order by | Enter the columns in the order in which you want them set up. The default database sort order will be used. Example: name, email | ||||||||||||
Limit offset | The starting row of the query. | ||||||||||||
Limit rows | The number of rows to return from the query. Example: 10 | ||||||||||||
Output fields | Enter or select output field names for SQL SELECT statement. To select all fields, leave it at default. Example: email, address, first, last | ||||||||||||
Fetch Output Fields In Schema |
Default value: Not selected | ||||||||||||
Pass through | If selected, the input document will be passed through to the output view under the key 'original'. Default value: Selected | ||||||||||||
Ignore empty result | If selected, no document will be written to the output view when a SELECT operation does not produce any result. If this property is not selected and the Pass through property is selected, the input document will be passed through to the output view. Default value: Not selected | ||||||||||||
Auto commit | Select one of the options for this property to override the state of the Auto commit property on the account. The Auto commit at the Snap-level has three values: True, False, and Use account setting. The expected functionality for these modes are:
Default value: False | ||||||||||||
Match data types | Conditional. This property applies only when the Output fields property is provided with any field value(s). If this property is selected, the Snap tries to match the output data types same as when the Output fields property is empty (SELECT * FROM ...). The output preview would be in the same format as the one when SELECT * FROM is implied and all the contents of the table are displayed. Default value: Not selected | ||||||||||||
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 | ||||||||||||
Staging Mode | Required when the value in the Number of retries field is greater than 0. Specify the location to store input documents between retries, from the following options:
To disable staging, enter 0 in the Number of retries field. Default value: In memory Example: On disk | ||||||||||||
|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|