Serialization
The Flyway lexicon serializes resources into TOML format compatible with
Flyway v10+ CLI configuration (flyway.toml).
Building
Section titled “Building”Run chant build to produce Flyway config from your declarations:
chant build# Writes dist/flyway.tomlThe generated file includes:
- Root-level project properties (id, name, databaseType)
[flyway]namespace with global settings[environments.<name>]sections for each environment[environments.<name>.resolvers.<type>]for credential resolvers[flywayDesktop]and[redgateCompare]optional namespaces
Key conversions
Section titled “Key conversions”| Chant (TypeScript) | TOML output | Rule |
|---|---|---|
new FlywayProject({...}) | Root-level keys | Project properties at document root |
new FlywayConfig({...}) | [flyway] section | Global Flyway settings |
new Environment({displayName: "dev", ...}) | [environments.dev] | Named environment section |
resolve("vault", "password") | ${vault.password} | Resolver reference string |
placeholder("defaultSchema") | ${flyway:defaultSchema} | Built-in placeholder string |
Applying
Section titled “Applying”The output is standard Flyway TOML. Use with the Flyway CLI:
flyway -environment=dev migrateflyway -environment=prod validate