Google CloudSQL PostgreSQL snapshot

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

STITCH
Release Status

Released

Supported By

Stitch

Stitch Plan

Free

Supported Versions

9.3+

Singer GitHub Repository

Postgres Repository

CONNECTION METHODS
SSH Connections

Unsupported

SSL Connections

Unsupported

REPLICATION SETTINGS
Anchor 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

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:

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

  • To be running PostgeSQL 9.3+ or greater. PostgreSQL 9.3.x is the minimum version Stitch supports for PostgreSQL integrations.


Step 1: Whitelist Stitch's IP addresses

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

  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 Authorization tab.
  5. 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.
  6. When finished, click Save to update the instance.

Step 2: Locate database connection details

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

  1. On the Cloud SQL Instances page, click the Overview tab.
  2. Locate the Connect to this instance section.
  3. Copy the IP address from the Primary IPv4 address box.

    The Primary IPv4 address box in Google Cloud Platform, highlighted

Keep the IP address handy - you’ll need it to complete the setup in Stitch.


Step 3: Create a Stitch database user

Next, 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.

Additionally, this user should also own the schema that Stitch is being granted access to.

CREATE USER [stitch_username] WITH ENCRYPTED PASSWORD '[secure password]';
GRANT CONNECT ON DATABASE [database_name] TO [stitch_username];
GRANT USAGE ON SCHEMA [schema_name] TO [stitch_username];
GRANT SELECT ON ALL TABLES IN SCHEMA [schema_name] TO [stitch_username];
ALTER DEFAULT PRIVILEGES IN SCHEMA [schema_name] GRANT SELECT ON TABLES TO [stitch_username];

Replace [secure password here] with a secure password. Additionally, make sure you replace [database_name] and [schema_name] with the appropriate names in your database. Repeat this process as necessary if you want to connect multiple databases or schemas.

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 4: Connect Stitch

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

Step 4.1: Define the database connection details

  1. Sign into your Stitch account, if you haven’t already.
  2. On the Stitch Dashboard page, click the Add Integration button.
  3. 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 data warehouse.

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

    • Host (Endpoint): Enter the host address (endpoint) of your CloudSQL MySQL instance. This will be the value of the Primary IPv4 address that you retrieved in Step 2.

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

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

    • Password: Enter the password for the Stitch 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 4.2: 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.

Stitch offers two methods of creating a replication schedule:

  • Replication Frequency: This method requires selecting the interval you want replication to run for the integration. Start times of replication jobs are based on the start time and duration of the previous job. Refer to the Replication Frequency documentation for more information and examples.
  • Anchor scheduling: Based on the Replication Frequency, or interval, you select, this method “anchors” the start times of this integration’s replication jobs to a time you select to create a predictable schedule. Anchor scheduling is a combination of the Anchor Time and Replication Frequency settings, which must both be defined to use this method. Additionally, note that:

    • A Replication Frequency of at least one hour is required to use anchor scheduling.
    • An initial replication job may not begin immediately after saving the integration, depending on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

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 5: Select data to replicate

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

When you track a table, you’ll also need to define its Replication Method and, if using Key-based Incremental Replication, its Replication Key.

You can select tables and columns by:

  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 object’s name. A green checkmark means the object is set to replicate.
  4. If there are child objects, they’ll automatically display and you’ll be prompted to select some.
  5. After you set a table to replicate, the Settings page will display. Note: When you track a table, by default all columns will also be tracked.

  6. In the Settings page, define the table’s Replication Method and, if using Key-based Incremental Replication, its Replication Key.

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

  8. Click the Finalize Your Selections button to save your data selections.

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.