Snap type:
Read
Description:
Snap type: | Read | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description: |
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: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.
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.
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.
Input | This Snap has exactly one input view. | ||
---|---|---|---|
Output | This Snap has at most one output view. | ||
Error | This Snap has at most one error view and produces zero or more documents in the view.
|
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:
Without using expressions
Using expressions
|
Warning | ||
---|---|---|
| ||
Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and is hence unsafe. Ensure that you understand all implications and risks involved before using concatenation of strings with '=' Expression enabled. |
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
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
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 selected
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.
Info |
---|
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. |
Example: 3
Default value: 0
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
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:
In memory: The query results are stored in the Snaplex memory. If the query is too large to fit in the memory space, it may cause the Snap to fail, so choose the On disk option.
On disk: The query results are stored on the disk in a temporary (
tmp
) directory that is managed by the SnapLogic platform. This directory is deleted automatically when the Snap terminates.
To disable staging, enter 0 in the Number of retries field.
Default value: In memory
Example: On disk
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|