ElasticMigrate

ElasticMigrate (esmigrate) applies versioned schema scripts to Elasticsearch and records every run in a SQL schema version table, in the spirit of Flyway. It is built for unattended, repeatable deployments: scripts run strictly in order, a failed script stops further migrations until it is resolved, concurrent runs are locked out, and every run can leave an audit trail.

• Elasticsearch 8 over plain HTTP(S), with TLS, mutual TLS, basic authentication or API keys.

• Schema version history in SQLite, PostgreSQL or MySQL, optionally in a dedicated schema and namespace.

• A small CLI with predictable exit codes for CI pipelines and scheduled jobs.

User guide

• Installation
  • Choose the database extra
  • Install a release
  • Install from source
• Quickstart
  • 1. Write a configuration file
  • 2. Write a migration script
  • 3. Run it
  • Next steps
• Configuration
  • Configuration files
  • Environment variables in values
  • Profile fields
  • Showing the configuration
• Migration scripts
  • File names
  • Script format
  • How scripts run
• Commands
  • Global options
  • init
  • config
  • upgrade
  • rollback
  • reset
  • unlock
  • Exit codes
• Security
  • TLS
  • Authentication
  • Mutual TLS
  • Keeping secrets out of files
• Schema databases
  • Connection URLs
  • Dedicated schema
  • Namespaces
  • Tables
  • Upgrading from ElasticMigrate v1
• Migration lock
  • Waiting for the lock
  • Removing a stuck SQLite lock
• Logging and audit trail
  • Console
  • Log file
  • Rotation

Project

• Migrating from v1
• Downloads
• Changelog
• Development