Skip to content

Konfiguration ​

Erzeugen und bearbeiten Sie migration_config.yml im Projektverzeichnis.

sh
migrate new config

Datenbank verbinden ​

PostgreSQL mit einer Verbindungszeichenfolge aus DATABASE_DSN:

yaml
# Datenbanktyp
dialect: postgres
# DATABASE_DSN vor der Ausführung setzen
data_source_name: "${DATABASE_DSN}"
# Verzeichnis der Migrationsdateien
migration_source: migrations
# Tabelle der ausgeführten Versionen
schema_name: migration_schema
FeldBedeutungStandard
dialectDatenbanktyppostgres
data_source_nameEinzelverbindung, nicht zusammen mit data_sourcesIm Einzelmodus erforderlich
data_sourcesBenannte VerbindungenDeaktiviert
migration_sourceMigrationsverzeichnismigrations
schema_nameVerlaufstabellemigration_schema
working_directoryAusgangspunkt der DateisucheAktuelles Verzeichnis
migrate_out_of_orderÄltere offene Versionen ausführenfalse
logger_leveldebug, info, warn, errorinfo

Verbindungsbeispiele ​

Ersetzen Sie Host, Port, Datenbank beziehungsweise Oracle-Dienst und setzen Sie DB_USER und DB_PASSWORD. SQLite verwendet einen Dateipfad.

yaml
dialect: postgres
data_source_name: "postgres://${DB_USER}:${DB_PASSWORD}@db.example:5432/app?sslmode=require"
yaml
dialect: mysql
data_source_name: "${DB_USER}:${DB_PASSWORD}@tcp(db.example:3306)/app?parseTime=true"
yaml
dialect: mariadb
data_source_name: "${DB_USER}:${DB_PASSWORD}@tcp(db.example:3306)/app?parseTime=true"
yaml
dialect: sqlite
data_source_name: "./demo.sqlite"
yaml
dialect: oracle
data_source_name: "oracle://${DB_USER}:${DB_PASSWORD}@db.example:1521/FREEPDB1"
yaml
dialect: mssql
data_source_name: "sqlserver://${DB_USER}:${DB_PASSWORD}@db.example:1433?database=app"
yaml
dialect: clickhouse
data_source_name: "clickhouse://${DB_USER}:${DB_PASSWORD}@db.example:9000/app"
yaml
dialect: tidb
data_source_name: "${DB_USER}:${DB_PASSWORD}@tcp(db.example:4000)/app?parseTime=true"
yaml
dialect: redshift
data_source_name: "postgres://${DB_USER}:${DB_PASSWORD}@cluster.example:5439/app?sslmode=require"

Sonderzeichen in Benutzernamen und Passwörtern von URLs (@, :, /) müssen URL-kodiert sein; die Variablenersetzung kodiert nicht automatisch. MySQL/MariaDB/TiDB verwenden mit user:password@tcp(...) kein URL-Format. TLS/SSL richten Sie nach den Serveranforderungen ein.

Protokollstufen ​

WertAusgaben
debugDebug, Information, Warnung, Fehler
infoInformation, Warnung, Fehler
warnWarnung und Fehler; auch warning
errorNur Fehler
yaml
logger_level: debug # Debug-Meldungen zur Fehlersuche anzeigen

Umgebungsvariablen ​

${DATABASE_DSN} erfordert eine gesetzte Variable. ${DB_NAME:app} verwendet andernfalls app. Dieselbe YAML-Datei kann verschiedene Umgebungen bedienen; Zugangsdaten kommen aus Variablen oder der Geheimnisverwaltung. SSH-Host, Benutzer und Proxyadresse unterstützen ebenfalls Vorlagen.

Suchreihenfolge ​

Im Arbeitsverzeichnis wird die erste vorhandene Datei verwendet:

  1. migration_config.yml
  2. migration_config.yaml
  3. migration_config.json

Dateien werden nicht kombiniert. Eine ungültige oder unlesbare gefundene Datei führt zum Fehler. Mit -c wird ausschließlich die angegebene Datei verwendet.

sh
migrate -c ./configs/dev.yml status

Konfiguration erzeugen ​

FallBefehl
Eine Datenbankmigrate new config
Eigener Dateinamemigrate new config dev.yml
Mehrere Datenbankenmigrate new config --multi
Vier Datenbankenmigrate new config --multi --shards 4
SSH Agentmigrate new config --ssh-tunnel
Privater Schlüsselmigrate new config --ssh-tunnel --ssh-auth private_key
SSH-Passwortmigrate new config --ssh-tunnel --ssh-auth password
SOCKS5migrate new config --ssh-tunnel --proxy socks5
HTTP CONNECTmigrate new config --ssh-tunnel --proxy http

Optionen sind kombinierbar. Überschreiben erfordert --force; alle Optionen stehen unter migrate new config --help.

sh
migrate new config shards.yml --multi --shards 4 --ssh-tunnel --proxy socks5

Mehrere Datenbanken ​

Verwenden Sie data_sources anstelle von data_source_name. Typ, Dateien und Name der Verlaufstabelle sind gemeinsam. Erzeugte Namen beginnen mit shard_0 und verwenden SHARD_0_DSN usw.

yaml
dialect: postgres
migration_source: migrations
schema_name: migration_schema
data_sources:
  shard_0:
    data_source_name: "${SHARD_0_DSN}" # Verbindung der ersten Datenbank
  shard_1:
    data_source_name: "${SHARD_1_DSN}" # Verbindung der zweiten Datenbank

Migrationsdateien → shard_0 / shard_1 → Ergebnisse

sh
migrate create
migrate up --dry-run
migrate up
migrate status

Jede Datenbank ermittelt offene Versionen anhand ihres eigenen Verlaufs und führt sie geordnet aus. Bereits erfolgreiche Versionen werden übersprungen. new version erzeugt eine gemeinsame Datei. Standardmäßig laufen höchstens 8 Datenbanken gleichzeitig; --parallel 1 arbeitet nacheinander.

sh
migrate up --parallel 4
migrate status --output json

Fehler stoppen andere Datenbanken nicht. Die Ergebnisse werden je Verbindung zusammengefasst; ein Fehler ergibt einen Exitcode ungleich null. Es gibt keine datenbankübergreifende Transaktion oder Rücknahme anderer Erfolge. Ctrl+C stoppt neue Aufträge und bricht aktive Operationen ab.

Ein globales ssh_tunnel dient allen Verbindungen. Ein lokales Objekt ersetzt es vollständig; fehlt es oder ist es null, wird das globale geerbt. Siehe SSH. Jede tatsächliche Datenbank nur einmal eintragen und überlappende Aufrufe serialisieren. Dateien und Abhängigkeiten während des Laufs unverändert lassen; vor Wiederholungen Daten und Verlauf prüfen.

Arbeitsverzeichnis ​

sh
migrate -w ./deploy up
migrate -w ./deploy -c configs/dev.yml status

-w bestimmt die Konfigurationssuche und überschreibt working_directory. Ein relatives migration_source bezieht sich darauf; -c allein ändert diesen Bezug nicht. Relative SSH-Dateipfade beziehen sich auf das Verzeichnis der Konfigurationsdatei.