A newer version of this documentation is available.
View Latest (v2.0)

Installation steps

Gluesync SQL to NoSQL for MS SQL Server

Prerequisites

In order to have Gluesync working on your MS SQL instance you will need to have:

  • valid user credentials with permissions of reading, writing to the target tables and respective database

To create a valid user for Gluesync on your MS SQL Server database you can run the following query:
CREATE LOGIN gluesync
    WITH PASSWORD = 'youdecide';
GO

ALTER SERVER ROLE sysadmin ADD MEMBER gluesync;
GO

Basic configuration example

This video tutorial will guide you through the basic configurations steps on setting up Gluesync for Microsoft SQL Server and Couchbase

The SQL to NoSQL module can be customized by using a configuration file, in JSON format. The file name to use must be specified as parameter when launching the app, with the -f or --file tokens. The file should be composed by union of common configuration file (see here Installation steps) and source/destination specific configuration:

{
  ...
  "mssql": {
    "temporaryTableNamePrefix": "table_prefix",
    "statePreservationTableNamePrefix": "state_prefix"
  },

  "sourceChangeRetention": 5
}

Microsoft SQL Server specific configurations are listed under the mssql property:

  • temporaryTableNamePrefix (optional): allow to specify a custom prefix for temporary table created by Gluesync to improve performance. Typical use case is to allow multiple instances of Gluesync to run from the same source, thus avoiding conflicts at runtime;

  • statePreservationTableNamePrefix (optional): allow to specify a custom prefix for state presevation table created by Gluesync to keep a checkpoint of processed changes. Typical use case is to allow multiple instances of Gluesync to run from the same source, thus avoiding conflicts at runtime;

  • sourceChangeRetention (optional): defaults to 5. Number of retention days preserved into the MS SQL Server change tracking system;

Looking for data modelling features or other options?

For more detailed configurations options, including the ability to perform data modelling, please have a look at the dedicated Data modelling section when sourcing from a RDBMS.

Troubleshooting

Here following the list of common errors.

  • com.microsoft.sqlserver.jdbc.SQLServerException: Invalid object name 'SYS.SCHEMAS'.: Gluesync checks SYS.SCHEMAS table in order to verify that the GLUESYNC schema is in place, otherwise he creates it. This error is trown when unsufficient permissions has been gave to the user given to Gluesync. Please check permissions and try again.