AlloyDB Account

In this article

Overview

You can use this account type to connect Google AlloyDB Snaps with data sources that use AlloyDB account.

Prerequisites

  • Valid Hostname, Database and User credentials.

Limitations and Known Issues

None.

Account Settings

 

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

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default Value: None
ExampleAlloyDB Account

String

Specify a unique label for the account.

 

Account properties

The account information required to create a connection to the PostgreSQL database.

Hostname

 

Default Value: None
Example: acc-postgresql-us-east-rds.amazonaws.com

String/Expression

Specify the AlloyDB server's address.

Port Number

Default Value: 5432
Example: 5432

Integer

Specify the port number of the database server to which you need to connect.

Database name

 

Default Value: N/A
Example: snapsdb

String/Expression

Specify the name of the database to which you need to connect.

Username

 

Default Value: N/A
Example: sladmin@sl.onmicrosoft.com

String/Expression

Specify the username that is allowed to connect to the database.
This username is used as the default username when retrieving connections and must be valid to set up the data source.

Password

 

Default Value: N/A
Example: P#2,nxu0oiX2&?

String/Expression

Specify the password used to connect to the data source.
This password is used as the default password when retrieving connections and must be valid to set up the data source.

JDBC JARs

Use this field set to list the JDBC jar files that must be loaded for the account to work.

JDBC Driver

 

Default Value: N/A
Example: postgresql-42.5.0.jar

String

Specify the JDBC driver that must be loaded for the account to work. By default, AlloyDB uses the latest jar file.

JDBC Driver Class

 

Default Value: org.postgresql.Driver
Example: org.postgresql.Driver

String

The JDBC driver class that you want to use with the account.

Configure SSH Tunnel

 

Default Value: Deselected

Checkbox

Select this checkbox to allow the Snap to create an SSH tunnel for connecting the Snaplex to the AlloyDB server. After the operation is completed, the tunnel is closed.

If you select true, you must provide the configuration details of the SSH tunnel.

SSH Auth Mode

 

Default Value: Password
Example: KeyFile (Private Key String)

String/Expression

Select an option to specify the mode for authenticating the user on the SSH tunnel. The available options are:

  • Password: Select this option if you want to use the configured SSH Hostname, SSH Username, and the SSH Password properties directly.

  • KeyFile (Private Key File): Select this option if you want to upload a file for the Key.

  • KeyFile (Private Key String): Select this option if you want to copy and paste the private key contents into the account.

Do not enable expression in this field. If you enable expression then the other fields that are based on the expression might not be available.

SSH Hostname

 

Default Value: N/A
Example: _SSH_Hostname

String/Expression

Specify either the IP address or the domain name of the SSH server to which you want to connect. or use an expression for this field.

SSH Username

 

Default Value: N/A
Example: _SSH_User

String/Expression

Specify the SSH username for connecting to the SSH tunnel. 

SSH Password

 

Default Value: N/A
Example: <Encrypted>

String/Expression

Specify the password for the specified SSH username for connecting to the SSH tunnel. This field is required if SSH Auth Mode is Password.

SSH Port

 

Default Value: 22
Example: 23

Integer/Expression

Specify the SSH port to connect to the PostgreSQL Server.

Ensure that there are no port conflicts.

Advanced properties

Advanced properties associated with the PostgreSQL account type.

Auto commit

 

Default valueSelected

Checkbox

Select this check box to commit batches as soon as they are executed. If the Snap fails, only the batch being executed at that moment is rolled back.

Deselect the check box to commit Snap execution output only after all the batches are executed. If the Snap fails, the entire transaction is rolled back unless the Snap finds invalid input data before it sends the insert request to the server and routes the error documents to the Error view.

Batch size*

Default Value: 50
Example: 60

Integer

Specify the number of statements to execute at a time.

Fetch size*

 

Default Value: 100
Example: 80

Integer

Specify the number of rows to fetch at a time when executing a query.
Large values could cause the server to run out of memory.

 

Max pool size*

 

Default Value: 50
Example: 60

Integer

Specify the maximum number of connections a pool must maintain at a time.

 

Max life time*

 

Default value: 30
Example: 50

Integer

Specify the maximum lifetime of a connection in the pool.

 

Idle Timeout*

 

Default value: 5
Example: 8

Integer

Specify the maximum amount of time a connection is allowed to sit idle in the pool.

A value of 0 indicates that idle connections are never removed from the pool.

 

Checkout timeout*

 

Default Value: 10000
Example: 8000

Integer

Specify the number of milliseconds to wait for a connection to be available when the pool is exhausted.

URL properties

Use this field set to define URL properties to use if any.

URL Property Name


Default Value: N/A
Example: socketTimeout

String

Specify a name for the URL property if any.

URL Property Value

 

Default Value: N/A
Example: 10

String

Specify a value for the URL property name.

Snap Pack History

Google AlloyDB Snap Pack