Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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

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. 


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:


InputThis Snap has exactly one input view.
OutputThis 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.

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

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:
 

Multiexcerpt include macro
nameME_DB_Snaps_Query_Examples
pageOracle - 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: nameemail 

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

Fetch Output Fields In Schema

Insert excerpt
https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439119/Cassandra + - + Selecthttps://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439119/
Cassandra + - + Select
nopaneltrue

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: TrueFalse, 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

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

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Insert excerpt
Vertica Snap Pack
Vertica Snap Pack
nopaneltrue