-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
557 additions
and
56 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # Hyperbee Migrations MongoDB Provider | ||
|
|
||
| Welcome to `Hyperbee.Migrations.Providers.MongoDB`, an extension to the foundational `Hyperbee.Migrations` library. This extension is specifically designed to incorporate support for MongoDB. | ||
|
|
||
| ## Introduction | ||
|
|
||
| The `Hyperbee.Migrations.Providers.MongoDB` library is an tool for developers seeking to perform database migrations in a MongoDB environment using the `Hyperbee.Migrations` library. This library furnishes a comprehensive suite of tools and functionalities that integrate effortlessly with `Hyperbee.Migrations`, thereby enabling developers to harness the robust capabilities of MongoDB in their applications. | ||
|
|
||
| The `Hyperbee.Migrations.Providers.MongoDB` library is equipped to assist developers in creating, updating, and managing their MongoDB databases. With the aid of this library, developers can concentrate their efforts on the development of their application, while the library handles the intricacies of database management. | ||
|
|
||
| We are committed to continuous improvement and feature enhancement. We appreciate your interest and look forward to your valuable feedback. | ||
|
|
||
| Please see [Hyperbee Migrations' Read Me](../Hyperbee.Migrations/README.md) for non-database specific usage. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Add MongoDB Services | ||
| ```c# | ||
| // In Startup.cs | ||
| public void ConfigureServices(IServiceCollection services) | ||
| { | ||
| // Configure MongoDB | ||
| services.AddTransient<IMongoClient, MongoClient>( _ => new MongoClient( connectionString ) ); | ||
|
|
||
| // Add the MigrationRunner | ||
| services.AddMongoDBMigrations(...); | ||
| } | ||
|
|
||
| public void Configure(IApplicationBuilder app, ...) | ||
| { | ||
| // Run pending migrations. | ||
| var migrationService = app.ApplicationServices.GetRequiredService<MigrationRunner>(); | ||
| migrationService.Run(); | ||
| } | ||
| ``` | ||
| ### Preventing simultaneous migrations | ||
|
|
||
| By default, Hyperbee Migrations prevents parallel migration runner execution. If you have 2 instances of your | ||
| app running, and both try to run migrations, Hyperbee Migrations will prevent the second instance from running | ||
| migrations and will log a warning. | ||
|
|
||
| Hyperbee Migrations accomplishes this by using a distributed lock at the database layer. The default | ||
| implementation is based on the provider and uses a timeout and an auto-renewal interval to prevent orphaned locks. | ||
|
|
||
| If you want to change this behavior you can override the default options: | ||
|
|
||
| ```c# | ||
| services.AddMongoDBMigrations( options => | ||
| { | ||
| // Locking is on by default. Set to false to allow simultaneous runners - but don't be that guy. | ||
| options.LockingEnabled = false; | ||
|
|
||
| // You can change locking behavior. Defaults shown. | ||
| options.LockMaxLifetime = TimeSpan.FromMinutes( 1 ); // max time-to-live | ||
| options.LockName = "ledger" | ||
| }); | ||
| ``` | ||
|
|
||
| ### Dependency Injection | ||
|
|
||
| Hyperbee Migrations relies on dependency injection to pass services to your migration. For MongoDB you can directly use the `IMongoClient` and interact with MongoDB directly. | ||
|
|
||
| ```c# | ||
| [Migration(1)] | ||
| public class MyMigration : Migration | ||
| { | ||
| private IMongoClient _mongoClient; | ||
| private ILogger _logger; | ||
|
|
||
| // Injected services registered with the container | ||
| public MyMigration( IMongoClient mongoClient, ILogger<MyMigration> logger ) | ||
| { | ||
| _mongoClient = mongoClient; | ||
| _logger = logger; | ||
| } | ||
|
|
||
| public async override Task UpAsync( CancellationToken cancellationToken = default ) | ||
| { | ||
| // do something with mongoClient | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The MongoDB provider also provides a `MongoDBResourceRunner<MyMigration>` that adds helpful functionality when using embedded resources. | ||
| - `DocumentsFromAsync` inserts documents into database/collections within MongoDB. This is normally use for pre seeding the database. | ||
|
|
||
| ```c# | ||
| [Migration(1)] | ||
| public class MyMigration : Migration | ||
| { | ||
| private readonly MongoDBResourceRunner<MyMigration> _resourceRunner; | ||
|
|
||
| public CreateInitialBuckets( MongoDBResourceRunner<MyMigration> resourceRunner ) | ||
| { | ||
| _resourceRunner = resourceRunner; | ||
| } | ||
|
|
||
| public override async Task UpAsync( CancellationToken cancellationToken = default ) | ||
| { | ||
| // run a `resource` migration to create initial state. | ||
| await resourceRunner.DocumentsFromAsync( [ | ||
| "administration/users/user.json" | ||
| ], cancellationToken ); | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # Hyperbee Migrations Postgres Provider | ||
|
|
||
| Welcome to `Hyperbee.Migrations.Providers.Postgres`, an extension to the foundational `Hyperbee.Migrations` library. This extension is specifically designed to incorporate support for Postgres. | ||
|
|
||
| ## Introduction | ||
|
|
||
| The `Hyperbee.Migrations.Providers.Postgres` library is an tool for developers seeking to perform database migrations in a Postgres environment using the `Hyperbee.Migrations` library. This library furnishes a comprehensive suite of tools and functionalities that integrate effortlessly with `Hyperbee.Migrations`, thereby enabling developers to harness the robust capabilities of Postgres in their applications. | ||
|
|
||
| The `Hyperbee.Migrations.Providers.Postgres` library is equipped to assist developers in creating, updating, and managing their Postgres databases. With the aid of this library, developers can concentrate their efforts on the development of their application, while the library handles the intricacies of database management. | ||
|
|
||
| We are committed to continuous improvement and feature enhancement. We appreciate your interest and look forward to your valuable feedback. | ||
|
|
||
| Please see [Hyperbee Migrations' Read Me](../Hyperbee.Migrations/README.md) for non-database specific usage. | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Add Postgres Services | ||
| ```c# | ||
| // In Startup.cs | ||
| public void ConfigureServices(IServiceCollection services) | ||
| { | ||
| // Configure Postgres | ||
| services.AddNpgsqlDataSource( connectionString ); | ||
|
|
||
| // Add the MigrationRunner | ||
| services.AddPostgresMigrations(...); | ||
| } | ||
|
|
||
| public void Configure(IApplicationBuilder app, ...) | ||
| { | ||
| // Run pending migrations. | ||
| var migrationService = app.ApplicationServices.GetRequiredService<MigrationRunner>(); | ||
| migrationService.Run(); | ||
| } | ||
| ``` | ||
| ### Preventing simultaneous migrations | ||
|
|
||
| By default, Hyperbee Migrations prevents parallel migration runner execution. If you have 2 instances of your | ||
| app running, and both try to run migrations, Hyperbee Migrations will prevent the second instance from running | ||
| migrations and will log a warning. | ||
|
|
||
| Hyperbee Migrations accomplishes this by using a distributed lock at the database layer. The default | ||
| implementation is based on the provider and uses a timeout and an auto-renewal interval to prevent orphaned locks. | ||
|
|
||
| If you want to change this behavior you can override the default options: | ||
|
|
||
| ```c# | ||
| services.AddPostgresDBMigrations( options => | ||
| { | ||
| // Locking is on by default. Set to false to allow simultaneous runners - but don't be that guy. | ||
| options.LockingEnabled = false; | ||
|
|
||
| // You can change locking behavior. Defaults shown. | ||
| options.LockMaxLifetime = TimeSpan.FromMinutes( 1 ); // max time-to-live | ||
| options.LockName = "ledger" | ||
| }); | ||
| ``` | ||
|
|
||
| ### Dependency Injection | ||
|
|
||
| The Postgres provider also provides a `PostgresResourceRunner<MyMigration>` that adds helpful functionality when using embedded resources. | ||
| - `SqlFromAsync` runs sql statements and can do any sort of updates supported by Postgres | ||
| - `AllSqlFromAsync` runs all the embedded resources with the resource named matching the Migration. See [1000-Initial](../../samples/Hyperbee.Migrations.Postgres.Samples/Migrations/1000-Initial.cs) as an example | ||
|
|
||
| ```c# | ||
| [Migration(1)] | ||
| public class MyMigration : Migration | ||
| { | ||
| private readonly MongoDBResourceRunner<MyMigration> _resourceRunner; | ||
|
|
||
| public CreateInitialBuckets( MongoDBResourceRunner<MyMigration> resourceRunner ) | ||
| { | ||
| _resourceRunner = resourceRunner; | ||
| } | ||
|
|
||
| public override async Task UpAsync( CancellationToken cancellationToken = default ) | ||
| { | ||
| // run a `resource` migration to create initial state. | ||
| await resourceRunner.SqlFromAsync( [ | ||
| "1-MyMigration.sql" | ||
| ], cancellationToken ); | ||
| } | ||
| } | ||
| ``` |
45 changes: 0 additions & 45 deletions
45
src/Hyperbee.Migrations/Hyperbee - Backup.Migrations.csproj
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.