| Appsplus panel macro confluence macro |
|---|
| data | {"features":["title","icon","rounded","collapsible","border"],"title":"General Guidelines. **Delete before publishing**","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
|---|
|
**Delete Before Publishing** Always use title casing for Heading formats 1 and 2. Always use active voice. Do not use "Please" anywhere in the document. Screenshots Always use the New Form UI. Be optically similar. Max size corresponding gridline to 1000 px size, as in the style guide. Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here. See Image Style Guide for details.
Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.
|
In this article
| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 2 |
|---|
| absoluteUrl | true |
|---|
|
Overview
You can use this Snap to execute arbitrary SQL.
| Info |
|---|
Valid JSON paths that are defined in the where clause for queries or statements are substituted with values from an incoming document. If the document is missing a value to be substituted into the query or statement documents is written to the error view.
If a select query is executed, the query's results are merged into the incoming document and any existing keys will have their values overwritten. On the other hand, the original document is written if there are no results from the query. |
Snap Type
<Snap name> AlloyDB Snap is a Read/ Write/Parse/Transform/Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… executes the specific query.
Prerequisites
...
Valid client ID.
A valid account with the required permissions
...
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
...
Works in Ultra Pipelines if....
...
Does not support Ultra Pipelines.
Limitations
None
Limitations
Does not support $$ as an escape character for enclosing string input, as $ is a reserved character for variable substitution in SnapLogic..
Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|
Input | Document Binary Binary or Document | | | Requires the EDI data and internal ID as a JSON documentIf the input view is defined, then the where clause can substitute incoming values for a given expression. |
Output | DocumentBinary Binary or Document | | | The EDI transaction ID and order confirmation. |
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: Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error. Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records. Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.
Learn more about Error handling in Pipelines. |
Snap Settings
| Appsplus panel macro confluence macro |
|---|
data | {"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/| Info |
|---|
","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
|---|
**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. <State what the option should do in this field>. The available options are: <bullet list of LoVs>
Specify the Salesforce API to be used. The available options are:... Select the <category> that you want to use. Available options are...
* Option 1<italicized>. <third person singular form of the verb>
* Option 2<italicized>. <third person singular form of the verb>
Select the API that you want to use. Available options are:
Bulk API. Sends the Snap execution request details as a bulk API call.
REST API. ...
OR
Select one of the three following modes in which the Snap executes:
* Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
* Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
* Disabled. Disables the Snap and all Snaps downstream from it.
Check boxes: If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data. If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property. Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
Enter the name for new account.
Specify the account ID to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
Notes in field descriptions Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below: Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such. Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.
|
| Info |
|---|
Asterisk ( * ): Indicates a mandatory field. Suggestion icon ( ): Indicates a list that is dynamically populated based on the configuration. Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic. Add icon ( ): Indicates that you can add fields in the fieldset. Remove icon ( ): Indicates that you can remove fields from the fieldset. Upload icon ( ): Indicates that you can upload files.
|
Field Name | Field Type | Field Dependency | Description |
|---|
Label* Default Value: | ELT Database Account AlloyDB Execute
Example: | ELT RS Account AlloyDB Execute | String | None. | The Specify a unique 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 |
SQL Statement 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 | None | String/Expression | Specify the SQL statement to execute on the server. Scenarios to successfully execute your SQL statements You must understand the following scenarios to successfully execute your SQL statements: Scenario 1: Executing SQL statements without expressions
If the expression toggle of the SQL statement field is not selected: The SQL statement must not be within quotes. The $<variable_name> parts of the SQL statement are expressions. In the below example, $id and $book. Additionally, the JSON path (e.g. $myName) is allowed only in the WHERE clause. If the SQL statement starts with SELECT (case-insensitive), the Snap regards it as a select-type query and executes once per input document. If not, it regards it as write-type query and executes in batch mode.
INSERT into SnapLogic.book (id, book) VALUES ($id,$book)
Scenario 2: Executing SQL queries with expressions
Enable the expression toggle of the SQL statement field is selected: The SQL statement must be within quotes. The + $<variable_name> + parts of the SQL statement are expressions, and must not be within quotes. In the below example, $tablename. The $<variable_name> parts of the SQL statement is bind parameter and must be within quotes. In the below example, $id and $book.
Note: Table name and column names must not be provided as bind parameters. Only values can be provided as bind parameters. |
Pass through
Default Value: Selected
| Checkbox | Select this checkbox to pass the input document to the output view under the key original. This field applies only queries with the SELECT statement. |
Ignore empty result
Default Value: Deselected
| Checkbox | Select this checkbox to not write any document to the output view when a SELECT operation does not produce any result.
If this checkbox is not selected and the Pass-through checkbox is selected, the input document is passed through to the output view. |
Number of Retries
Default Value: 0
Example: 3
| Integer/Expression | Specify 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. |
Retry Interval (Seconds)
Default Value: 1
Example: 10
| Integer/Expression | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt resulted in an exception. |
Auto Commit
Default Value: Use account setting
Example: True
| Dropdown list | Choose one of the following options to override the state of the Auto commit on the account. True - The Snap executes with auto-commit enabled regardless of the value set for Auto commit in the Account used by the Snap. False - The Snap executes with auto-commit disabled regardless of the value set for Auto commit in the Account used by the Snap. Use account setting - The Snap executes with Auto commit property value inherited by the Account used by the Snap.
Auto commit may be enabled for certain use cases if AlloyDB JDBC driver is used in either Redshift, AlloyDB or generic JDBC Snap. But the JDBC driver may cause out of memory issues when Select statements are executed. In such cases, Auto Commit in Snap should be set to ‘False’ and the Fetch size in the Account settings can be increased for optimal performance. Behavior of DML Queries in Database Execute Snap when auto-commit is false DDL queries used in the Database Execute Snap will be committed by the Database itself, regardless of the Auto-commit setting. When Auto commit is set to false for the DML queries, the commit is called at the end of the Snap's execution. The Auto commit must be true in a scenario where the downstream Snap depends on the data processed on an Upstream Database Execute Snap containing a DML query. When the Auto commit is set to Use account setting on the Snap, the account level commit needs to be enabled.
|
Snap Execution Default Value: Execute only
Example: Validate & Execute | Dropdown list | N/A | Select one of the following three modes in which the Snap executes: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.
|
Troubleshooting
Error | Reason | Resolution |
|---|
| | |
Account validation failed. | 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
...
Snap Pack History
| Insert excerpt |
|---|
| XYZ WIP-Google Alloy DB Snap PackXYZ |
|---|
| WIP-Google Alloy DB Snap Pack |
|---|
|
Related Links
...
Endpoint Doc Link 1
...
Endpoint Doc Link 2
...
...
