https://github.com/joachimdalen/Migratio
Migratio is a PowerShell module to handle PostgreSQL database migrations
https://github.com/joachimdalen/Migratio
database-migrations hacktoberfest migration-tool postgres
Last synced: 5 months ago
JSON representation
Migratio is a PowerShell module to handle PostgreSQL database migrations
- Host: GitHub
- URL: https://github.com/joachimdalen/Migratio
- Owner: joachimdalen
- License: mit
- Created: 2021-02-06T09:40:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-03T07:49:15.000Z (over 3 years ago)
- Last Synced: 2024-08-03T22:16:47.376Z (8 months ago)
- Topics: database-migrations, hacktoberfest, migration-tool, postgres
- Language: C#
- Homepage: https://www.nuget.org/packages/Migratio/
- Size: 323 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - joachimdalen/Migratio - Migratio is a PowerShell module to handle PostgreSQL database migrations (C# #)
README
| Migratio is a PowerShell module to handle database migrations and seeding. It supports rollout, rollback and seeding data. |
| :------------------------------------------------------------------------------------------------------------------------: |
| Have the need to use variables or secrets in your script? **Migratio** supports that as well. |
| ⚠️ Migratio is far from complete and tested, so some things might not work as expected. Please take care if you decide to use this before a release. |
| :--------------------------------------------------------------------------------------------------------------------------------------------------: |
## :file_cabinet: Supported databases
So far Migratio only supports PostgreSQL, but MSSQL is alo planned. Submit a feature request in the issues if you wish support for a different database.
---
- [:desktop_computer: Cmdlets](#desktop_computer-cmdlets)
- [:heavy_dollar_sign: Variables](#heavy_dollar_sign-variables)
- [:gear: Configuration File](#gear-configuration-file)
---
# :desktop_computer: Cmdlets
See detailed documentation [here](./docs/cmdlets.md)
| Name | Description |
| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- |
| [New-MgMigration](./docs/cmdlets.md#New-MgMigration) | Create a new rollout and rollback migration |
| [New-MgMigrationTable](./docs/cmdlets.md#New-MgMigrationTable) | Create a new migration table in the database |
| [New-MgSeeder](./docs/cmdlets.md#New-MgSeeder) | Create a new seeder migration |
| | |
| [Get-MgUsedVariables](./docs/cmdlets.md#Get-MgUsedVariables) | Get a list over used variables for a migration file. See [Variables](#Variables) for more info |
| [Get-MgLatestIteration](./docs/cmdlets.md#Get-MgLatestIteration) | Get the latest iteration of migrations applied |
| [Get-MgProcessedMigrations](./docs/cmdlets.md#Get-MgProcessedMigrations) | Get all the applied migrations |
| [Get-MgScriptsForLatestIteration](./docs/cmdlets.md#Get-MgScriptsForLatestIteration) | Get all the applied migrations for the latest iteration |
| [Get-MgProcessedSeeders](./docs/cmdlets.md#Get-MgProcessedSeeders) | Get all the applied seeders |
| | |
| [Invoke-MgRollout](./docs/cmdlets.md#Invoke-MgRollout) | Run a rollout of migrations that is not applied yet |
| [Invoke-MgRollback](./docs/cmdlets.md#Invoke-MgRollback) | Run a rollback of the latest iteration of migrations |
| [Invoke-MgSeeding](./docs/cmdlets.md#Invoke-MgSeeding) | Run all unapplied seeders |
## :heavy_dollar_sign: Variables
Want to use environment variables in your migration scripts? Well, Migratio supports that. Simply insert `${{YOUR_VARIABLE}}` and Migratio will replace the value during migration, seeding or rollback when the `ReplaceVariables` option is set.
```sql
CREATE USER applicationUser WITH ENCRYPTED PASSWORD '${{APP_USER_PASSWORD}}';
```
## :gear: Configuration File
```yaml
directories:
base: /dev/migrations # Path to base directory containing subfolders
rollout: /dev/migrations/rollout # Path to rollout scripts
rollback: /dev/migrations/rollback # Path to rollback scripts
seeders: /dev/migrations/seeders # Path to seeder scripts
envMapping: # Mapping/Translation of variables and env variables
MG_DB_PASSWORD: DB_USERNAME
envFile: "./backend.env" # Path to env file
auth: # DB auth options
postgres:
host: "localhost"
port: 1234
database: "TestDB"
username: "postgres"
password: "${{MG_DB_PASSWORD}}" # Will use DB_USERNAME under lookup (ref: envMapping)
replaceVariables: true # Replace variables in rollout scripts
```
Multiple environments are also supported
```yaml
environments:
[envName]:
...config
```
```yaml
environments:
development:
directories:
base: /dev/migrations
rollout: /dev/migrations/rollout
rollback: /dev/migrations/rollback
seeders: /dev/migrations/seeders
envMapping:
MG_DB_PASSWORD: DB_USERNAME
envFile: "./backend.env"
auth:
postgres:
host: "localhost"
port: 1234
database: "TestDB"
username: "postgres"
password: "${{MG_DB_PASSWORD}}"
replaceVariables: true
production:
directories:
base: /prod/migrations
rollout: /prod/migrations/rollout
rollback: /prod/migrations/rollback
seeders: /prod/migrations/seeders
envMapping:
MG_DB_PASSWORD: DB_PROD_USERNAME
envFile: "./backend.prod.env"
auth:
postgres:
host: "localhost"
port: 1234
database: "ProdDB"
username: "produser"
password: "${{MG_DB_PASSWORD}}"
replaceVariables: true
```