Google Cloud SQL Server

Last updated on Mar 09, 2023

Prerequisites
Whitelist Hevo’s IP Addresses
Create a User and Grant Privileges
- Option 1. Configuring the user account using Google Cloud console
- Option 2. Configuring the user account using SQL Server client
Retrieve the Configuration Details (Optional)
Specify Google Cloud SQL Server Connection Settings
Revision History

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.

Getting Started

Setup

Prerequisites

The Google Cloud SQL Server instance is running. To check this, access your Google Cloud SQL Instances page and look for an Active indication next to the instance ID.
The SQL Server version is 2017.
Hevo’s IP addresses are whitelisted.
db_datareader privilege is granted to the database user.
Username, password, database names, database hostname, and port number of the Source instance are available.

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:

Access the Google Cloud SQL Instances page and click the Instance ID that you want to use.
In the left navigation pane, under Overview, click Connections.
In the Connections page, select the Public IP check box, and then, click + Add Network.
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.
(Optional) Click + Add network to add another IP address.
Click Save.

Create a User and Grant Privileges

Option 1. Configuring the user account using Google Cloud console

Click the master Google Cloud SQL Server instance.
In the left navigation pane, under Connections, click the Users tab, and then, click + ADD USER ACCOUNT.
Specify the user account information and 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:

Log in to the database schema where you want to add the user:
```
USE <schema_name>;
```
(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>';
```

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

Access the Google Cloud SQL Instances page.
Locate the hostname of the master instance under the Public IP address column.

The default port value is 1433.

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

Access the Google Cloud SQL Instances page.
Click your database instance, and then, click the Databases tab.

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

Specify Google Cloud SQL Server Connection Settings

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

For Ingestion mode as Table, read Object Settings for steps to configure the objects to be replicated.
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.

Click TEST CONNECTION. Hevo’s underlying connectivity checker validates the connection settings you provide.

Note: The TEST CONNECTION button is enabled once all the mandatory fields are specified.
Click TEST & CONTINUE to proceed for setting up the Destination.

Note: The TEST & CONTINUE button is enabled once all the mandatory fields are specified.

Revision History

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

Date	Release	Description of Change
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