ElasticMigrate

Schema migrations for Elasticsearch

ElasticMigrate (esmigrate) applies versioned schema scripts to Elasticsearch and records every run in a SQL schema version table, in the spirit of Flyway. 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 HTTP(S), with TLS, mutual TLS, basic authentication or API keys.
• Schema version history in SQLite, PostgreSQL or MySQL, in a dedicated schema and namespace if needed.
• Predictable exit codes for CI pipelines and scheduled jobs.

Documentation: zobayer.net/elastic-migrate (quickstart, migrating from v1)

Installation

ElasticMigrate requires Python 3.11 or newer. Signed releases are published on GitHub Releases; see Downloads for verification steps.

python -m pip install "./elastic_migrate-2.0.0-py3-none-any.whl[postgres]"

Use the postgres or mysql extra for those databases; SQLite needs no extra.

Quickstart

config.json:

{
  "profiles": [
    {
      "default": {
        "elastic_host": "http://localhost:9200",
        "schema_db": "sqlite:///esmigrate.db",
        "schema_dir": "./migrations"
      }
    }
  ]
}

migrations/V1_0__create_tweets_index.esm:

PUT /tweets
{"mappings": {"properties": {"user": {"type": "keyword"}, "message": {"type": "text"}}}}

Run it:

esmigrate init
esmigrate upgrade

License

Licensed under the Apache License 2.0. Releases up to v1.0.0-alpha.1 were published under the MIT License.