Skip to content

Latest commit

 

History

History
58 lines (51 loc) · 3.9 KB

README.md

File metadata and controls

58 lines (51 loc) · 3.9 KB
Raw

Apache Ignite Migration Tool

Apache Ignite Migration Tool is an open-source library for applying Apache Ignite database schema changes.

Coverage Status CI

Features

  • The data migration is performed in 3 stages:
    1. exporting data and meta data from a live Apache Ignite cluster into an isolated filesystem directory in form of Avro files.
    2. applying database schema transformations to the exported data and writing the transformed data into a separate filesystem directory.
    3. uploading the transformed Avro files to the new cluster.
  • data and metadata transformations are defined in a way that is Avro format agnostic (which allows use of Apache Beam for applying database transformations).
  • The tool provides minimal patch-tools API for patching data using Apache Beam
  • Data and metadata transformations are applied to Avro files and do not require a live Apache Ignite cluster.
  • The tool can be used for creating data backups that are Apache Ignite version independent (assuming definitions of CacheConfiguration and AffinityKey classes are stable).
  • Source and target cluster topologies do not have to be the same.
  • Encrypted caches are supported.
  • List of supported cache value field datatypes is not limited
  • Cache keys can be of arbitrary non-user defined Java types and AffinityKey on such.
  • Approximately unlimited objects complexity is supported including nested objects, collections, maps and others. An example of a data structure which can be processed by the tool:
{
  "FlightList": [
     {
        "id": 49507,
        "personList": [
           {
              "name": "Person25064",
              "age": 34,
              "passport": {
                 "id": "B56022"
              }
           },
           {
              "name": "Person25077",
              "age": 45,
              "passport": {
                 "id": "B74149"
              }
           }
        ]
     }
  ]
}

For more examples of how to make a backup and apply your patches please see the demo module.

Assumptions

  • Apache Ignite cluster from which the data is migrated from and the cluster to which the data is migrated to should be different clusters.
  • All nodes of Apache Ignite cluster to which the data is migrated to should have access to new definitions of all data classes (i.e. corresponding to the transformed schema). This can be achived by placing jar file with new data classes definitions to each node's class path. It is the tool's user responsibility to make sure that this assumption holds, the tool doesn't automate this process in any way.
  • Caches/tables that are not persisted in Ignite Persistence (in-memory only caches) are backed up by the tool along with the persisted caches. It is up to the data transformation patch (see here for a patch example) to make sure that in-memory caches are ignored (if needed) upon deserialization from Avro.

Getting started

The tool cannot be considered as the boxed product with a user-friendly CLI just yet. However, it is designed as a set re-usable building blocks with well-defined interfaces between them. The best way to get yourself familiar with the tool is to run demo/run_demo.sh script and study the source code from top to the bottom (starting with the script). We assume that users of the tool will be able to clone the repository and tailor-fit the tool to their needs.