Appsplus panel macro confluence macro | ||
---|---|---|
| ||
**Delete Before Publishing**
|
In this article
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
You can use this Snap to...
Snap Type
<Snap name> Snap is a Read/Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates…
Prerequisites
Valid client ID.
A valid account with the required permissions.
None.
Support for Ultra Pipelines
...
Works in Ultra Pipelines.
...
Works in Ultra Pipelines if....
...
In this article
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Overview
You can use this Snap to fetch data from a database by providing a table name and configuring the connection. 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 specific JSON path will be written to Snap's error view.
...
Queries produced by this Snap have an equivalent format:
|
For more powerful functionality is desired, then use Execute Snap.
Snap Type
The AlloyDB Select Snap is a Read-type Snap.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
None.
Known Issues
None.
When returning nonstandard types, the SQL statement will return a PGObject. You must use the Execute Snap in these cases.
Behavior Change
Multiexcerpt fast include block macro | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input |
Document
BinaryOutput
Document
Binary
Binary orDocument |
|
|
Copy
..
Requires the EDI data and internal ID as a JSON document.
| This Snap has at most one document input view. If the input view is defined, then the where clause can substitute incoming values for a given expression (in for example, to use it as a lookup). | |||
Output | Document |
|
| This Snap produces one document for each row in the table. 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. A second view can be added to push the metadata for the table as a document. The metadata document can then be passed into the second input view of AlloyDB Insert Snap so that the table is created in AlloyDB with a similar schema as the source table. | ||||
Error | 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:
Learn more about Error handling in Pipelines. |
Snap Settings
Appsplus panel macro confluence macro | ||
---|---|---|
| ||
**Delete Before Publishing** Choose from the following sentences to document specific field types. Drop-down lists/Option Buttons (radio buttons): You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.
Check boxes:
Text Fields
Numeric Text Fields
Notes in field descriptions
|
Info |
---|
|
...
Field Name
...
Field Type
...
Field Dependency
...
Description
Label*
Default Value: ELT Database Account
Example: ELT RS Account
...
String
...
None.
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.
Number of records
Default Value:
Example:
...
String/Expression
...
Sampling Type is Number of records.
...
Enter the number of records to output.
...
Field set Name
Specify advanced parameters that you want to include in the request.
...
Field 1*
Default Value: <value> or None.
Example: <value>
...
String
...
Debug mode check box is not selected.
...
Field 2
Default Value: <value> or None.
Example: <value>
...
String
...
Info |
---|
|
Field Name | Field Type | Field Dependency | Description | |||
---|---|---|---|---|---|---|
Label* Default Value: AlloyDB Select | String | N/A | Specify a unique name for the Snap. | |||
Schema name Default Value: N/A | String/Expression/Suggestion | N/A | 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 will retrieve available database schemas during suggest values. | |||
Table name* Default Value: N/A | String/Expression/Suggestion | N/A | Specify the name of the table to execute a select query on. | |||
Where clause Default Value: N/A Without using expressions
Using expressions
| String/Expression/Suggestion | N/A | Where clause of the select statement. This supports document value substitution (such as $person.firstname will be substituted with the value found in the incoming document at the path).
| |||
Order By | Enter the columns in the order in which you want to order by. The default database sort order will be used. | |||||
Limit offset Default Value: None | Integer/Expression/Suggestion | N/A | Number of rows to return from the query. | |||
Limit rows Default Value: None. | Integer/Expression/Suggestion | N/A | Number of rows to return from the query. | |||
Output fields Default Value: None | String/Expression/Suggestion | N/A | Enter or select output field names for the SQL SELECT statement. To select all fields, leave it at the default. | |||
Fetch output fields In schema Default Value: Not Selected | Checkbox | N/A | Select this checkbox to include only the selected fields or columns in the Output Schema (second output view). If you do not provide any Output fields, all the columns are visible in the output. | |||
Pass through Default Value: Selected | Checkbox | N/A | If checked, the input document will be passed through to the output view under the 'original' key. | |||
Ignore empty result Default Value: Not Selected | Checkbox | N/A | 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. | |||
Auto commit Default Value: False | Dropdown List | N/A | 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:
| |||
Match data types Default Value: Not Selected | Checkbox | N/A | This property applies only when the Output fields property is provided with any field value. 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. | |||
Number of retries Default Value: 0 | Integer/Expression | N/A | 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. 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. | |||
Retry interval (seconds) Default Value: 1 | Integer/Expression | N/A | Specifies the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. | |||
Staging mode Default Value: In memory | Dropdown List | 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. | |||
Snap Execution Default Value: | Dropdown list | N/A | Select one of the following three modes in which the Snap executes:
|
Troubleshooting
Error
Reason
Resolution
|
The Pipeline ended before the batch could complete execution due to a connection error.
Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.
Examples
Excluding Fields from the Input Data Stream
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:
<screenshot of Pipeline/Snap and description>
Download this Pipeline.
Downloads
Info |
---|
|
Attachments | ||||
---|---|---|---|---|
|
Snap Pack History
Insert excerpt |
---|
...
|
...
|
...
Related Links
Endpoint Doc Link 1
Endpoint Doc Link 2
Endpoint Doc Link 3
...