Project

synchronised_migration

0.0
Low commit activity in last 3 years
No release in over a year
synchronised_migrationsealink/synchronised-migration-rbHomepageDocumentationSource Code
Use Redis to record the data migration status
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
31,362
Stars
0
Forks
0
Watchers
2
 Releases
Current version
3.2.0
Total releases
15
First release
2017-09-11
Latest release
2023-01-17
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
12
Pull Request Acceptance Rate
92%
 Development
Primary Language
Ruby
Average date of last 50 commits
2020-09-01
Reverse Dependencies
0

 Dependencies

Development

pry-byebug
>= 3.5
rake
>= 0
rspec
>= 3.6
standardrb
>= 0
timecop
>= 0
coverage-kit
>= 0

Runtime

redlock
>= 0.2
dry-cli
>= 0
redis
>= 4.2.1
tty-table
>= 0
 Project Readme

Synchronised Migration

Gem Version Build Status

This gem makes it possible to deploy multiple instances with data migration simultaneously. It uses Redis to ensure that there will be only one migration running.

Usage

Migrating an application

bundle exec synchronised-migration migrate --config=migration.yml --version=1.2.3

Checking lock stats

bundle exec synchronised-migration status --config=migration.yml --version=1.2.3

Clearing locks

If a previous migration has failed a new one will not be allowed to start unless it is first cleared.

bundle exec synchronised-migration clear --config=migration.yml

If you wish to clear all locks, *including the running lock then you must also provide version

bundle exec synchronised-migration clear --config=migration.yml --version=1.2.3 --all

Configuration

Key Description
redis_uri Redis server to use for locking
application Application being migrated
version Version being migrated too
debug Enable additional debug information
command Command to execute for the migration
timeout_milliseconds Timeout to wait for the lock
retry_delay_milliseconds Retry for the lock every x milliseconds

Overriding config file options

You may override certain config options such as the redis-uri and the debug flag by providing them via cli options.

bundle exec synchronised-migration migrate --config=migration.yml --version=1.2.3 --redis_uri=redis://127.0.0.1:6379/0

Release

To publish a new version of this gem the following steps must be taken.

  • Update the version in the following files 
      CHANGELOG.md
  lib/synchronised_migration/version.rb
  • Create a tag using the format v0.1.0
  • Follow build progress in GitHub actions