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

Installation steps

Gluesync SQL to NoSQL for MySQL

Prerequisites

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

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

Schemas and tables identification

In order to connect and perform the desired operations on your source MySQL database Gluesync requires you to name name your entities in the configuration file using this nomenclature: schemaName.tableName where, for example, for the schema Inventory and table Articles you should have inventory.articles.

The resulting JSON config file for your MySQL entities will look like this example:

{
  ...
  "sourceEntities": {
    "inventory.articles": {},
    "inventory.customers": {},
    "inventory.addresses": {},
    ...
  },
  ...
}

You can mix multiple schemas in your config file.

Basic configuration example

This 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:

{
  ...
  "mysql": {
    "certificatesPath": "/path/to/certs/dir/cert.pem"
  },

  "sourceChangeRetention": 5
}

MySQL specific configurations are listed under the mysql property:

  • certificatesPath (optional): the path to the certificates that need to be used when connecting to a MySQL instance using a secure connection. If omitted, no certificates are used;

You can also specify few other options that applies to this configuration, like: * sourceChangeRetention (optional): defaults to 5. Number of retention days preserved into the Gluesync GDC action_logs table inside your MySQL database;

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.