Share
Google Cloud SQL Server Setup Guide

Google Cloud SQL Server is a fully-managed database service that helps you set up, maintain, manage, and administer your SQL Server relational databases on Google Cloud Platform.

You can ingest data from your Google Cloud SQL Server database using Hevo Pipelines and replicate it to a Destination of your choice.

Prerequisites

Perform the following steps to configure your Google Cloud SQL Server Source:

Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP address for your region to enable Hevo to connect to your Google Cloud SQL Server database. To do this:

  1. Access the Google Cloud SQL Instances page and click the Instance ID that you want to use.

    Click instance

  2. In the left navigation pane, click Connections.

    Click connections

  3. In the Networking tab, select the Public IP check box and then click + ADD A NETWORK.

    Add network

  4. Specify the following in the Edit Network section:

    • Name: A name for this connection. For example, all or Hevo IP address.

    • Network: The IP address of the site to grant access to. Specify 0.0.0.0/0 to authorize all sites or your region’s IP address to specifically whitelist Hevo’s IP address.

    This adds the IP address to the list of Authorized networks.

  5. (Optional) Click + Add network to add another IP address.

  6. Click Save.

Create a User and Grant Privileges

Option 1. Configuring the user account using Google Cloud console

  1. Access the Google Cloud SQL Instances page and click the master Google Cloud SQL Server instance.

    Click instance

  2. In the left navigation pane, under Connections, click the Users tab, and then, click + ADD USER ACCOUNT.

    Click add user account

  3. Specify the user account information and click ADD.

    Click ADD

    You will specify this username and password while creating your Hevo Pipeline.

Option 2. Configuring the user account using SQL Server client

Log in to your SQL Server instance as masteruser using your preferred SQL Server client tool, and enter the following commands:

  1. Log in to the database where you want to add the user:

    USE <database_name>;

  2. (Optional) Create a login user.

    Note: You can skip this step if you want to use the existing login user to create a new database user.

    CREATE LOGIN <login_user> WITH PASSWORD = '<password>';

  3. Create a new database user and grant read privileges:

    CREATE USER hevo for login <master_username>;
EXEC sp_addrolemember 'db_datareader', 'hevo';

Retrieve the Configuration Details (Optional)

Refer to the steps below to gather the configuration details required to create your Hevo Pipeline:

1. Retrieve the hostname and port number

Note: Following is an example of Google Cloud SQL Server hostname and port number:
Host : 35.220.150.0
Port : 1433

  1. Access the Google Cloud SQL Instances page.

  2. Locate the hostname of the master instance under the Public IP address column.

    The default port value is 1433.

    Locate hostname

    You will specify these while creating your Hevo Pipeline.

2. Retrieve the username and password

To retrieve your username and password, follow the steps in section, Create a User and Grant Privileges.

3. Retrieve the database names

  1. Access the Google Cloud SQL Instances page.

  2. Click your database instance, and then, click the Databases tab.

    Locate database

On this page, you can locate the name of your database under the Name column.

Specify Google Cloud SQL Server Connection Settings

Perform the following steps to configure Google Cloud SQL Server as a Source in Hevo:

  1. Click PIPELINES in the Navigation Bar.

  2. Click + CREATE PIPELINE in the Pipelines List View.

  3. On the Select Source Type page, select Google Cloud SQL Server.

  4. On the Configure your Google Cloud SQL Server Source page, specify the following:

    GCloud SQL Server settings

    • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

    • SQL Server Host: SQL Server host’s IP address or DNS.

      The following table lists a few examples of SQL Server hosts:

      Variant Host
      Amazon RDS SQL Server ms-sql-server-1.xxxxx.rds.amazonaws.com
      Azure MS SQL mssql.database.windows.net
      Generic MS SQL 10.123.10.001 or mssql.westeros.inc
      Google Cloud SQL Server 35.220.150.0

      Note: For URL-based hostnames, exclude the http:// or https:// part. For example, if the hostname URL is https://mssql.database.windows.net, enter mssql.database.windows.net.

    • SQL Server Port: The port on which your SQL Server is listening for connections. Default value: 1433.

    • SQL Server User: The read-only user who has the permissions to read tables in your database.

    • SQL Server Password: The password for the read-only user.

    • Select an Ingestion Mode: The desired mode by which you want to ingest data from the Source. You can expand this section by clicking SEE MORE to view the list of ingestion modes to choose from. Default value: Change Tracking. The available ingestion modes are Change Tracking, Table, and Custom SQL.

      Ingestion Modes

      Depending on the ingestion mode you select, you must configure the objects to be replicated. Refer to section, Object and Query Mode Settings for the steps to do this.

      Note: For Custom SQL ingestion mode, all Events loaded to the Destination are billable.

    • Database Name: The database that you wish to replicate.

    • Schema Name: The schema that holds the tables to be replicated. Default value: dbo.

    • Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your SQL Server database host to Hevo. This provides an additional level of security to your database by not exposing your SQL Server setup to the public. Read Connecting Through SSH.

      If this option is disabled, you must whitelist Hevo’s IP addresses. Refer to the content for your SQL Server variant for steps to do this.

    • Advanced Settings:

      • Include New Tables in the Pipeline: Applicable for all ingestion modes except Custom SQL. If enabled, Hevo automatically ingests data from tables created after the Pipeline has been built. If disabled, the new tables are listed in the Pipeline Detailed View in Skipped state, and you can manually include the ones you want and load their historical data. You can include these objects post-Pipeline creation to ingest data.

        You can change this setting later.

  5. Click TEST CONNECTION. This button is enabled once you specify all the mandatory fields. Hevo’s underlying connectivity checker validates the connection settings you provide.

  6. Click TEST & CONTINUE to proceed for setting up the Destination. This button is enabled once you specify all the mandatory fields.

Object and Query Mode Settings

Once you have specified the Source connection settings in Step 4 above, do one of the following:

  • For Pipelines configured with the Change Tracking ingestion mode:

    1. On the Select Objects page, select the objects you want to replicate.

    2. Click CONTINUE. This button is enabled once you select at least one object for which Change Tracking is enabled.

      Query-Mode Selection

      Note:

      • Each object represents a table in your database.

      • You must enable Change Tracking for the objects you want to ingest data from. If disabled, Hevo adds these objects to your Pipeline in the SKIPPED state.

      • For customers signing up after Release 2.19, Hevo automatically uses the Unique Incrementing Append Only (UIAO) query mode for the objects that contain a unique column. For the others, it ingests data using the Full Load query mode.

  • For Pipelines configured with the Table ingestion mode:

    1. On the Select Objects page, select the objects you want to replicate and click CONTINUE.

      Object Selection

      Note: Each object represents a table in your database.

    2. On the Configure Objects page, specify the query mode you want to use for each selected object.

      Query-Mode Selection

  • For Pipelines configured with the Custom SQL ingestion mode:

    1. On the Provide Query Settings page, enter the custom SQL query to fetch data from the Source.

    2. In the Query Mode drop-down, select the query mode, and click CONTINUE.

      Custom SQL

Data Replication

For Teams Created Default Ingestion Frequency Minimum Ingestion Frequency Maximum Ingestion Frequency Custom Frequency Range (in Hrs)
Before Release 2.21 15 Mins 5 Mins 24 Hrs 1-24
After Release 2.21 6 Hrs 30 Mins 24 Hrs 1-24

Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests all available data for the selected objects from your Source database.
  • Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Error 1003 - Authentication error

Potential Causes

  • The credentials of the database user authorizing the connection are incorrect.

Suggested Actions

  • Verify that the password entered in the Configure your Source page for the authorizing user is correct.

  • Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Error 1005 - Connection timeout

Potential Causes

  • The database connection details are incorrect.
  • Hevo’s IP addresses are not whitelisted.

Suggested Actions

Error 1006 - Insufficient access

Potential Causes

  • Hevo’s IP addresses are not whitelisted.

Suggested Actions

Error 1011 - Access denied

Potential Causes

  • The username or password is incorrect.

Suggested Actions

  • Verify that the Database user entered in the Configure your Source page is correct.

  • Verify that the Database password entered in the Configure your Source page is correct.

  • Invite another team member with the required privileges to set up the Pipeline. Read Inviting and Moderating Team Members.

Limitations

  • Hevo does not support data replication from temporary tables and views.

  • Hevo does not load an Event into the Destination table if its size exceeds 128 MB, which may lead to discrepancies between your Source and Destination data. To avoid such a scenario, ensure that each row in your Source objects contains less than 100 MB of data.

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Jan-07-2025 NA Updated the Limitations section to add information on Event size.
Oct-22-2024 NA Updated section, Whitelist Hevo’s IP Addresses as per the latest Google Cloud SQL Server UI.
Apr-29-2024 NA Updated section, Specify Google Cloud SQL Server Connection Settings to include more detailed steps.
Mar-05-2024 2.21 Added the Data Replication section.
Jan-15-2024 NA Added section, Limitations.
Jan-10-2024 2.19 Updated section, Object and Query Mode Settings as per the latest Hevo functionality.
Nov-03-2023 NA Added section, Object and Query Mode Settings.
Apr-21-2023 NA Updated section, Specify Google Cloud SQL Server Connection Settings to add a note to inform users that all loaded Events are billable for Custom SQL mode-based Pipelines.
Mar-09-2023 2.09 Updated section, Specify Google Cloud Server Connection Settings to mention about SEE MORE in the Select an Ingestion Mode section.
Dec-19-2022 2.04 Updated section, Specify Google Cloud SQL Server Connection Settings to add information that you must specify all fields to create a Pipeline.
Dec-07-2022 2.03 Updated section, Specify Google Cloud SQL Server Connection Settings to mention about including skipped objects post-Pipeline creation.
Dec-07-2022 2.03 Updated section, Specify Google Cloud SQL Server Connection Settings to mention about the connectivity checker.
Jun-28-2022 NA Removed section, Source Considerations.
Apr-21-2022 1.86 Updated section, Specify Google Cloud SQL Server Connection Settings.
Jul-26-2021 1.68 Added a note for the SQL Server Host field.
Jul-12-2021 NA Added section, Specify Google Cloud SQL Server Connection Settings.
Feb-22-2021 1.57 New Document
Last updated on Jan 07, 2025

Tell us what went wrong

Skip to the section