Versions Compared

Key

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

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
minLevel1
maxLevel2
absoluteUrltrue

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
minLevel1
maxLevel2
absoluteUrltrue

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:

Code Block
SELECT * FROM [table] WHERE [where clause] ORDER BY [ordering] LIMIT [limit] OFFSET [offset]

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
macro_uuidb5714512-e268-406b-90d7-42ae380a5b28
nameBehavior change for driver upgrade
templateDataeJyLjgUAARUAuQ==
pageAlloyDB Bulk Load
addpanelfalse

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or

Output

Document

Binary

Binary or

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • ..

  • Requires the EDI data and internal ID as a JSON document.

    • JSON Generator

    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

    • Min: 1

    • Max: 2

    • Bulk Load

    • File Writer

    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 EDI transaction ID and order confirmation

    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:

    • 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 ((blue star)): Indicates a list that is dynamically populated based on the configuration.

    • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

    • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

    • Remove icon ( (blue star)): Indicates that you can remove fields from the fieldset.

    • Upload icon ((blue star) ): Indicates that you can upload files.

    ...

    Field Name

    ...

    Field Type

    ...

    Field Dependency

    ...

    Description

    Label*

    Default ValueELT Database Account
    ExampleELT 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
    • Asterisk ( * ): Indicates a mandatory field.

    • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

    • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

    • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

    • Remove icon ( (blue star)): Indicates that you can remove fields from the fieldset.

    • Upload icon ((blue star) ): Indicates that you can upload files.

    Field Name

    Field Type

    Field Dependency

    Description

    Label*

    Default ValueAlloyDB Select
    ExampleSelect Query

    String

    N/A

    Specify a unique name for the Snap.

    Schema name

    Default Value: N/A
    ExampleSYS

    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
    Example: people

    String/Expression/Suggestion

    N/A

    Specify the name of the table to execute a select query on.

    Where clause

    Default Value: N/A
    Example:

    Without using expressions

    • email = 'you@example.com' or email = $email 

    • emp=$emp

    Using expressions

    • "EMPNO=$EMPNO and ENAME=$EMPNAME"

    • "emp='" + $emp + "'"

    • "EMPNO=" + $EMPNO + " and ENAME='" + $EMPNAME+ "'"

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

    Note

    Caution:

    Using expressions that join strings together to create SQL queries or conditions has a potential SQL injection risk and therefore is 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 to order by. The default database sort order will be used.

    Limit offset

    Default Value: None
    Example10

    Integer/Expression/Suggestion

    N/A

    Number of rows to return from the query.

    Limit rows 

    Default Value: None.
    Example10

    Integer/Expression/Suggestion

    N/A

    Number of rows to return from the query.

    Output fields

    Default Value: None
    Example: email, address, first, last, etc.

    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
    Example: 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.
    If you provide output fields, we recommend you select the Fetch Output Fields In Schema check box.

    Pass through

    Default Value: Selected
    Example: Not 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
    Example: 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
    Example: True

    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: TrueFalse, and Use account setting. The expected functionality for these modes are:

    •  True - The Snap will execute with autocommit 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 the Auto commit property value inherited by the Account used by the Snap.

    Match data types

    Default Value: Not Selected
    Example: 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
    Example: 3

    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
    Example: 10

    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
    Example: On disk

    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:

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

    Snap Execution

    Default Value
    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

    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
    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts, as applicable.

    3. Provide Pipeline parameters, as applicable.

    Attachments
    patterns*.slp, *.zip
    sortByname

    Snap Pack History

    Insert excerpt

    ...

    Google AlloyDB Snap Pack

    ...

    Google AlloyDB Snap Pack
    nameGoogle AlloyDB SPH

    ...

    ...