Google Cloud SQL for SQL Server Setup Guide

IMPORTANT: You must have TLS enabled on your database to connect directly to Fivetran. Follow Google Cloud's TLS setup instructions to enable TLS on your database.

Fivetran connects directly to your database instance. This is the simplest connection method.

To connect directly, configure your firewall and/or other access control systems to allow incoming connections to your SQL server host and port (usually 1433) from Fivetran's IPs for your database's region.

Fivetran connects to a separate server in your network that provides an SSH tunnel to your database. You must connect through SSH if your database is in an inaccessible subnet.

To connect using SSH, do the following:

1. In your connector setup form, select Connect via an SSH tunnel to expose Fivetran's public SSH key. Copy the key by clicking the blue clipboard icon.

2. Add the public key to the authorized_keys file of your SSH server. The key must be all on one line, so make sure that you don't introduce any line breaks when cutting and pasting.

3. If you want Fivetran to tunnel SSH over TLS, follow Google Cloud's TLS setup instructions to enable TLS on your database.

IMPORTANT: You must have a Business Critical plan to use Google Cloud Private Service Connect.

NOTE: This connection method is in Beta.

Google Cloud Private Service Connect allows VPCs and Google-hosted or on-premises services to communicate with one another without exposing traffic to the public internet. Learn more in Google Cloud's Private Service Connect documentation.

Follow our Google Cloud Private Service Connect setup guide to configure Private Service Connect for your database.

1. Enable change tracking at the database level:

   ALTER DATABASE [<database>] 
   SET CHANGE_TRACKING = ON 
   (CHANGE_RETENTION = 7 DAYS, AUTO_CLEANUP = ON);
   

   NOTE: While we recommend seven days of change retention, you can set your retention period as low as one day. However, a shorter retention period increases the risk that your logs will expire in between syncs, triggering an automatic full source re-sync.

2. Enable CT for each table you want to integrate:

   ALTER TABLE [<schema>].[<table>] ENABLE CHANGE_TRACKING;
   

3. Grant the Fivetran user VIEW CHANGE TRACKING permission for each of the tables that have CT enabled:

   GRANT VIEW CHANGE TRACKING ON [<schema>].[<table>] TO <username>;
   

1. Enable change data capture at the database level:

   EXEC msdb.dbo.gcloudsql_cdc_enable_db '[<database>]'
   

2. Enable CDC for each table you want to Fivetran to sync:

   EXEC sys.sp_cdc_enable_table  
   @source_schema = [<schema>],
   @source_name   = [<table>],
   @role_name     = [<username>],
   @supports_net_changes = 0;
   

   To check if CDC is enabled, run the query below:

   EXEC sys.sp_cdc_enable_table
   @source_schema = N'[<schema>]',
   @source_name = N'[<table>]',
   @role_name = N'CDC'
   

   NOTE: Fivetran only supports tables with a single CDC capture instance. Our syncs only include tables and columns that are present in a CDC instance. If you add new tables or columns, you must create a new CDC instance that includes them and delete the old instance.

   NOTE: When @supports_net_changes is set to 1, an additional non-clustered index is created on the change table. Because this index needs to be maintained, enabling net changes can degrade CDC performance.

1. Install the following script on your database. Before running the script, replace <database> with your database name.

   NOTE: If you have configured your connector to "Allow columns", you can exclude the [dbo].[sp_ft_enable_cdc] and [dbo].[sp_ft_enable_change_tracking] stored procedures. If you have configured your connector to "Block All", you can exclude all the following stored procedures.

   USE [<database>];
   
   /****** Object:  StoredProcedure [dbo].[sp_ft_enable_cdc]    Script Date: 1/17/2024 11:12:55 PM ******/
   SET ANSI_NULLS ON
   GO
      
   SET QUOTED_IDENTIFIER ON
   GO
      
   CREATE OR ALTER PROCEDURE [dbo].[sp_ft_enable_cdc]
      @TableList NVARCHAR(MAX),
      @FivetranUser NVARCHAR(MAX)
   WITH EXECUTE AS OWNER -- Change to an appropriate sysadmin user
   AS
   BEGIN
      SET NOCOUNT ON;
   
      -- Table to store tables with results
      CREATE TABLE #ResultTables (TableName NVARCHAR(MAX), Result NVARCHAR(MAX));
   
      -- Enable CDC for each table
      DECLARE @TableName NVARCHAR(MAX);
      DECLARE @SqlStatement NVARCHAR(MAX);
   
      WHILE LEN(@TableList) > 0
      BEGIN
         -- Get the first table in the list
         SET @TableName = NULL;
         SET @TableName = SUBSTRING(@TableList, 1, CHARINDEX(',', @TableList + ',') - 1);
   
         -- Remove the processed table from the list
         SET @TableList = STUFF(@TableList, 1, LEN(@TableName) + 1, '');
   
         -- Build and execute the SQL statement to enable CDC for the table
         SET @SqlStatement = '
         BEGIN TRY
            EXEC sys.sp_cdc_enable_table
                @source_schema = ''' + PARSENAME(@TableName, 2) + ''',
                @source_name   = ''' + PARSENAME(@TableName, 1) + ''',
                @role_name     = ''' + @FivetranUser + ''',
                @supports_net_changes = 0;
            
            INSERT INTO #ResultTables (TableName, Result) VALUES (''' + @TableName + ''', ''Success'');
         END TRY
         BEGIN CATCH
            PRINT ERROR_MESSAGE();
            INSERT INTO #ResultTables (TableName, Result) VALUES (''' + @TableName + ''', ERROR_MESSAGE());
         END CATCH
         ';
   
        -- Execute the dynamic SQL statement
        EXEC sp_executesql @SqlStatement;
      END
   
      -- Return the list of tables with results
      SELECT * FROM #ResultTables;
         
      -- Drop the temporary table
      DROP TABLE #ResultTables;
   END;
   GO
   
   
   /****** Object:  StoredProcedure [dbo].[sp_ft_enable_change_tracking]    Script Date: 1/17/2024 11:10:45 PM ******/
   SET ANSI_NULLS ON
   GO
      
   SET QUOTED_IDENTIFIER ON
   GO
      
   CREATE OR ALTER PROCEDURE [dbo].[sp_ft_enable_change_tracking]
      @TableList NVARCHAR(MAX),
      @FivetranUser NVARCHAR(MAX)
   WITH EXECUTE AS OWNER -- Change to an appropriate sysadmin user
   AS
   BEGIN
      SET NOCOUNT ON;
         
      -- Table to store tables with results
      CREATE TABLE #ResultTables (TableName NVARCHAR(MAX), Result NVARCHAR(MAX));
         
      -- Enable change tracking for each table
      DECLARE @TableName NVARCHAR(MAX);
      DECLARE @SqlStatement NVARCHAR(MAX);
         
      WHILE LEN(@TableList) > 0
      BEGIN
         -- Get the first table in the list
         SET @TableName = NULL;
         SET @TableName = SUBSTRING(@TableList, 1, CHARINDEX(',', @TableList + ',') - 1);
         
         -- Remove the processed table from the list
         SET @TableList = STUFF(@TableList, 1, LEN(@TableName) + 1, '');
            
         -- Build and execute the SQL statement to enable change tracking
         SET @SqlStatement = '
         BEGIN TRY
            ALTER TABLE ' + @TableName + ' ENABLE CHANGE_TRACKING;
            GRANT VIEW CHANGE TRACKING ON ' + @TableName + ' TO ' + @FivetranUser + ';
            INSERT INTO #ResultTables (TableName, Result) VALUES (''' + @TableName + ''', ''Success'');
         END TRY
         BEGIN CATCH
            PRINT ERROR_MESSAGE();
            INSERT INTO #ResultTables (TableName, Result) VALUES (''' + @TableName + ''', ERROR_MESSAGE());
         END CATCH
         ';
            
         -- Execute the dynamic SQL statement
         EXEC sp_executesql @SqlStatement;
      END
         
      -- Return the list of tables with results
      SELECT * FROM #ResultTables;
         
      -- Drop the temporary table
      DROP TABLE #ResultTables;
   END;
   GO
   
     
   /****** Object:  StoredProcedure [dbo].[sp_ft_get_tables_with_ddl_changes]    Script Date: 1/30/2024 9:10:47 PM ******/
   SET ANSI_NULLS ON
   GO
      
   SET QUOTED_IDENTIFIER ON
   GO
   
   CREATE OR ALTER PROCEDURE [dbo].[sp_ft_get_tables_with_ddl_changes]
      @TableList NVARCHAR(MAX),
      @ddlTime DATETIME = NULL -- New parameter for ddlTime
   WITH EXECUTE AS OWNER -- Change to an appropriate sysadmin user
   AS
   BEGIN
      SET NOCOUNT ON;
   
      -- Declare a table variable to store the results
      DECLARE @ChangedTables TABLE (
         TableName NVARCHAR(MAX),
         DdlTime DATETIME
      );
   
      -- Split the comma-separated list into a table variable
      DECLARE @TableNames TABLE (
         TableName NVARCHAR(MAX)
      );
         
      INSERT INTO @TableNames (TableName)
      SELECT value
      FROM STRING_SPLIT(@TableList, ',');
         
      -- Check for DDL changes in cdc.ddl_history
      INSERT INTO @ChangedTables (TableName, DdlTime)
      SELECT
         tn.TableName,
         MAX(dh.ddl_time) AS LatestDdlTime
      FROM cdc.ddl_history dh
      INNER JOIN @TableNames tn ON CONCAT(OBJECT_SCHEMA_NAME(dh.source_object_id), '.', OBJECT_NAME(dh.source_object_id)) = tn.TableName
      WHERE @ddlTime IS NULL OR dh.ddl_time >= @ddlTime
      GROUP BY tn.TableName;
         
      -- Return the list of tables with the latest DDL changes
      SELECT TableName, DdlTime
      FROM @ChangedTables;
   END;
   GO
   
   
   
   /****** Object:  StoredProcedure [dbo].[sp_ft_update_cdc]    Script Date: 1/31/2024 1:19:40 AM ******/
   SET ANSI_NULLS ON
   GO
   
   SET QUOTED_IDENTIFIER ON
   GO
   
   CREATE OR ALTER PROCEDURE [dbo].[sp_ft_update_cdc]
      @TableName NVARCHAR(MAX),
      @FivetranUser NVARCHAR(MAX),
      @CaptureInstance NVARCHAR(MAX),
      @CapturedColumnList NVARCHAR(MAX)
   WITH EXECUTE AS OWNER
   AS
   BEGIN
      SET NOCOUNT ON;
   
       -- Table to store tables with results
       CREATE TABLE #ResultTables (TableName NVARCHAR(MAX), Result NVARCHAR(MAX));
   
       DECLARE @SourceSchema NVARCHAR(MAX);
       DECLARE @SourceName NVARCHAR(MAX);
   
       BEGIN TRY
           -- Assign values to variables for PARSENAME function
           SET @SourceSchema = PARSENAME(@TableName, 2);
           SET @SourceName = PARSENAME(@TableName, 1);
   
           -- Step 1: Disable the current CDC instance
           EXEC sys.sp_cdc_disable_table
               @source_schema    = @SourceSchema,
               @source_name      = @SourceName,
               @capture_instance = @CaptureInstance;
   
           -- Step 2: Create a new CDC instance
           EXEC sys.sp_cdc_enable_table
               @source_schema        = @SourceSchema,
               @source_name          = @SourceName,
               @role_name            = @FivetranUser,
               @capture_instance     = @CaptureInstance,
               @captured_column_list = @CapturedColumnList,
               @supports_net_changes = 0;
   
           -- Insert the result into the #ResultTables table
           INSERT INTO #ResultTables (TableName, Result) VALUES (@TableName, 'Success');
       END TRY
       BEGIN CATCH
           PRINT ERROR_MESSAGE();
           -- Insert the error message into the #ResultTables table
           INSERT INTO #ResultTables (TableName, Result) VALUES (@TableName, ERROR_MESSAGE());
       END CATCH;
   
       -- Return the list of tables with results
       SELECT * FROM #ResultTables;
   
       -- Drop the temporary table
       DROP TABLE #ResultTables;
   END;
   GO
   
   

2. Grant the Fivetran user execute permission.

   USE [<database>];
   GRANT EXECUTE ON dbo.sp_ft_enable_cdc to <username>;
   GRANT EXECUTE ON dbo.sp_ft_enable_change_tracking to <username>;
   GRANT EXECUTE ON dbo.sp_ft_get_tables_with_ddl_changes to <username>;
   GRANT EXECUTE ON dbo.sp_ft_update_cdc to <username>;