...
You can use this Snap to execute arbitrary SQL.
This Snap works only with single queries.
...
Snap Type
The AlloyDB Execute Snap is a Write-type Snap that executes the specific query.
...
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
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.
Behavior Change
| Multiexcerpt fast include block macro |
|---|
| macro_uuid | bb20fb9c-7a0c-4e4b-a4ef-7e969855132d |
|---|
| name | Behavior change for driver upgrade |
|---|
| templateData | eJyLjgUAARUAuQ== |
|---|
| page | AlloyDB Bulk Load |
|---|
| addpanel | false |
|---|
|
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|
Input | Document | | | If the input view is defined, then the WHERE clause can substitute incoming values for a given expression. 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, it is written to the error view. |
Output | Document | | | The executed query result. 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. |
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
| 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 | Description |
|---|
Label* Default Value: AlloyDB Execute
Example: AlloyDB Execute | String | Specify a unique name for the Snap. |
SQL Statement Default Value:
Example: | String/Expression | Specify the SQL statement to execute on the server. |
We recommend you to add a single query in the SQL Statement field. 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 example below, $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. |
Query type Default Value: Auto
Example: Read | Dropdown list/Expression | Select the type of query for your SQL statement (Read or Write). When Auto is selected, the Snap tries to determine the query type automatically.
If the execution result of the query is not as expected, you can change the query type to Read or Write. |
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 to 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 retry attempts the Snap must make in case there is a network failure and is unable to read the target file. The request is terminated if the attempts do not result in a response. If the Number of retries value is set to 0 (the default value), the retry option is disabled, and the Snap does not initiate a retry. The pipeline will not attempt to retry the operation in case of a failure—any failure encountered during the database operation will immediately result in the pipeline failing without any retry attempts to recover from the errors. If the Number of retries value is greater than 0, the Snap initiates a download of 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 then attempts to download the file again from the beginning. After 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
Example: 10
| Integer/Expression | Specify the time interval between two successive retry requests. A retry happens only when the previous attempt results 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 the Auto commit property value inherited by the Account used by the Snap.
Auto commit may be enabled for certain use cases if the AlloyDB JDBC driver is used in either the Redshift, AlloyDB, or generic JDBC Snap. However, the JDBC driver may cause out of memory issues when SELECT statements are executed. In such cases, Auto Commit in the 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 | 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.
|
Snap Pack History
| Insert excerpt |
|---|
| Google AlloyDB Snap Pack |
|---|
| Google AlloyDB Snap Pack |
|---|
| nopanel | true |
|---|
|
...
