Google CloudSQL PostgreSQL feature snapshot

A high-level look at Stitch's Google CloudSQL PostgreSQL (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on July 31, 2018

Supported by

Stitch

Stitch plan

Standard

Supported versions

9.3+

API availability

Available

Singer GitHub repository

singer-io/tap-postgres

CONNECTION METHODS
SSH connections

Unsupported

SSL connections

Unsupported

REPLICATION SETTINGS
Anchor Scheduling

Supported

Advanced Scheduling

Supported

Table-level reset

Supported

Configurable Replication Methods

Supported

REPLICATION METHODS
Log-based Replication

Unsupported

Key-based Replication

Supported

Full Table Replication

Supported

DATA SELECTION
Table selection

Supported

Column selection

Supported

View replication

Supported

Select all

Unsupported

TRANSPARENCY
Extraction Logs

Supported

Loading Reports

Supported

Connecting Google CloudSQL PostgreSQL

Google CloudSQL PostgreSQL setup requirements

To set up Google CloudSQL PostgreSQL in Stitch, you need:

  • A database running PostgreSQL 9.3.x or greater. PostgreSQL 9.3.x is the minimum version Stitch supports for PostgreSQL integrations.

  • Permissions in Google Cloud that allow you to modify the database’s connection settings. This is required to whitelist Stitch’s IP addresses.

  • Permissions in PostgreSQL that allow you to create users. This is required to create a database user for Stitch.


Step 1: Configure database connection settings

For Stitch to successfully connect with your CloudSQL instance, you’ll need to add our IP addresses to the database’s authorized networks list.

Authorized networks with Stitch IP addresses highlighted in the Google Cloud SQL database connections tab

  1. Sign into your Google Cloud Platform account.
  2. Navigate to the Cloud SQL Instances page.
  3. Click the instance name to open its details page.
  4. Click the Connections tab.
  5. Locate the Public IP section.
  6. For each of the following IP addresses, complete the following:

    1. Click + Add network.
    2. In the Name field, enter a name for the IP address. For example: Stitch 1 for the first IP address, Stitch 2 for the second, and so on.
    3. In the Network field, paste one of the following IP addresses:

      • 52.23.137.21/32

      • 52.204.223.208/32

      • 52.204.228.32/32

      • 52.204.230.227/32

    4. Click Done.
    5. Repeat these steps until all of Stitch’s IP addresses have been added.
  7. When finished, click Save to update the instance.

Step 2: Create a Stitch database user

In this step, you’ll create a dedicated database user for Stitch. This will ensure Stitch is visible in any logs or audits, and allow you to maintain your privilege hierarchy.

Your organization may require a different process, but the simplest way to create this user is to execute the following query when logged into the Google CloudSQL PostgreSQL database as a user with the right to grant privileges.

Note: The user performing this step should also own the schema(s) that Stitch is being granted access to.

  1. Log into your database.
  2. Create the database user, replacing <stitch_username> with the name of the database user and <password> with a password:

    CREATE USER <stitch_username> WITH ENCRYPTED PASSWORD '<password>'
    
  3. Grant the database user CONNECT privileges to the database, replacing <database_name> with the name of a database you want to connect Stitch to:

    GRANT CONNECT ON DATABASE <database_name> TO <stitch_username>
    
  4. Grant the database user schema usage privileges, replacing <schema_name> with the name of a schema you want to replicate data from:

    GRANT USAGE ON SCHEMA <schema_name> TO <stitch_username>
    
  5. Grant the database user SELECT privileges by running this command for every table you want to replicate:

    GRANT SELECT ON <schema_name>.<table_name> TO <stitch_username>
    

    Limiting access to only the tables you want to replicate ensures that the integration can complete discovery (a structure sync) in a timely manner. If you encounter issues in Stitch where tables aren’t displaying, try limiting the Stitch database user’s table access.

  6. Alter the schema’s default privileges to grant SELECT privileges on tables to the database user. This is required to ensure that objects created in the schema after connecting to Stitch will remain accessible to the stitch user:

    ALTER DEFAULT PRIVILEGES IN SCHEMA <schema_name> GRANT SELECT ON TABLES TO <stitch_username>
    
  7. If you want to replicate data from multiple databases or schemas, repeat steps 3 - 6 as needed.

See the Privileges list tab for an explanation of why these permissions are required by Stitch.

In the table below are the database user privileges Stitch requires to connect to and replicate data from a Google CloudSQL PostgreSQL database.

Privilege name Reason for requirement
CONNECT

Required to connect successfully to the specified database.

USAGE

Required to access the objects contained in the specified schema.

SELECT

Required to select rows from tables in the specified schema.

ALTER DEFAULT PRIVILEGES

Required to ensure that objects created in the schema after connecting to Stitch will be accessible by the Stitch database user.

Step 3: Connect Stitch

In this step, you’ll complete the setup by entering the database’s connection details and defining replication settings in Stitch.

Step 3.1: Locate the database connection details in Google

Google CloudSQL PostgreSQL Public IP address field

In this step, you’ll locate the Google CloudSQL PostgreSQL database’s public IP address in the Google Cloud Platform console. This will be used to complete the setup in Stitch.

  1. In the CloudSQL Instances page, locate the instance you want to connect to Stitch.
  2. When the instance’s Overview page displays, scroll down to the Connect to this instance section.
  3. Locate the Public IP address field.
  4. Copy and paste the public IP address into a text file or leave this page open and open your Stitch account in another tab.

Step 3.2: Define the database connection details in Stitch

  1. If you aren’t signed into your Stitch account, sign in now.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Locate and click the Google CloudSQL PostgreSQL icon.
  4. Fill in the fields as follows:

    • Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

      For example, the name “Stitch Google CloudSQL PostgreSQL” would create a schema called stitch_google_cloudsql_postgresql in the destination. Note: The schema name cannot be changed after the integration is saved.

    • Host (Endpoint): Enter the host address (endpoint) of your Google CloudSQL PostgreSQL instance. This will be the value of the Public IP address that you retrieved in Step 3.1.

    • Port: Enter the port used by the instance. The default is 5432.

    • Username: Enter the Stitch Google CloudSQL PostgreSQL database user’s username.

    • Password: Enter the password for the Stitch Google CloudSQL PostgreSQL database user.

    • Database: Enter the name of the Google CloudSQL PostgreSQL database you want to connect to Stitch. Stitch will ‘find’ all databases you give the Stitch user access to - a default database is only used to complete the connection. This is required for Google CloudSQL PostgreSQL integrations.

    • Include PostgreSQL schema names in destination tables: Checking this setting will include schema names from the source database in the destination table name - for example: <source_schema_name>__<table_name>.

      Stitch loads all selected replicated tables to a single schema, preserving only the table name. If two tables canonicalize to the same name - even if they’re in different source databases or schemas - name collision errors can arise. Checking this setting can prevent these issues.

      Note: This setting can not be changed after the integration is saved. Additionally, this setting may create table names that exceed your destination’s limits. For more info, refer to the Database Integration Table Name Collisions guide.

Step 3.3: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Google CloudSQL PostgreSQL integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 3.4: Save the integration

When finished, click Check and Save.

Stitch will perform a connection test to the Google CloudSQL PostgreSQL database; if successful, a Success! message will display at the top of the screen. Note: This test may take a few minutes to complete.

Step 4: Select data to replicate

The last step is to select the tables and columns you want to replicate.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Google CloudSQL PostgreSQL integrations, you can select:

  1. Individual tables and columns

  2. Database views

Click the tabs to view instructions for each selection method.

  1. In the Integration Details page, click the Tables to Replicate tab.
  2. Locate a table you want to replicate.
  3. Click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  4. After you set a table to replicate, a page with the table’s columns will display. De-select columns if needed.

  5. Next, you’ll define the table’s Replication Method. Click the Table Settings button.
  6. In the Table Settings page:
    1. Define the table’s Replication Method.

    2. If using Key-based Incremental Replication, select a Replication Key.

    3. When finished, click Update Settings.

  7. Repeat this process for every table you want to replicate.

  8. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Setting a database view to replicate is similar to selecting a table, with a few differences. Refer to the Replicating Database Views guide for detailed instructions.

At a high level, you’ll need to complete the following to select a database view:

  1. Verify the database user’s permissions
  2. Select the view
  3. Optional: Define the view’s Primary Key
  4. Define the view’s Replication Method
  5. Save the view’s settings

Initial and historical replication jobs

After you finish setting up Google CloudSQL PostgreSQL, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.


Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.