Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiwiproject/dropwizard-mongo-migrations
Library to provide database migrations for MongoDB similar to dropwizard-migrations for RDBS
https://github.com/kiwiproject/dropwizard-mongo-migrations
dropwizard java migrations mongodb
Last synced: about 2 months ago
JSON representation
Library to provide database migrations for MongoDB similar to dropwizard-migrations for RDBS
- Host: GitHub
- URL: https://github.com/kiwiproject/dropwizard-mongo-migrations
- Owner: kiwiproject
- License: mit
- Created: 2021-09-30T20:00:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T22:22:30.000Z (about 2 months ago)
- Last Synced: 2024-11-25T23:25:53.851Z (about 2 months ago)
- Topics: dropwizard, java, migrations, mongodb
- Language: Java
- Homepage:
- Size: 257 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
### Dropwizard Mongo Migrations
[](https://github.com/kiwiproject/dropwizard-mongo-migrations/actions?query=workflow%3Abuild)
[](https://sonarcloud.io/dashboard?id=kiwiproject_dropwizard-mongo-migrations)
[](https://sonarcloud.io/dashboard?id=kiwiproject_dropwizard-mongo-migrations)
[](https://github.com/kiwiproject/dropwizard-mongo-migrations/actions/workflows/codeql.yml)
[](https://javadoc.io/doc/org.kiwiproject/dropwizard-mongo-migrations)
[](https://opensource.org/licenses/MIT)
[](https://central.sonatype.com/artifact/org.kiwiproject/dropwizard-mongo-migrations/)
Dropwizard Mongo Migrations is a simple library to assist in migrating Mongo databases in
[Dropwizard](https://www.dropwizard.io) applications. This library provides a set of Dropwizard commands similar to
Dropwizard's migration library for RDBMS systems.
The migrations are performed by the library [Mongock](https://www.mongock.io). This bundle sets up the configuration to
use the Mongock migration framework as a
Dropwizard [command](https://www.dropwizard.io/en/latest/manual/core.html#commands).
### Using dropwizard-mongo-migrations
To use this library, you need to add a `MongoMigrationsBundle`. Here is an example of adding a `MongoMigrationsBundle`
to a Dropwizard application.
First, provide necessary properties in your Configuration class. For example:
```java
// imports...
// Note this assumes Lombok to generate getter and setter methods
@Getter
@Setter
public class AppConfiguration extends Configuration {
private String migrationPackage;
private String mongoUri;
private String mongoDbName;
}
```
Next, create a new `MongoMigrationsBundle` in the `initialize` of your `Application` class and add the bundle to
the `Bootstrap` object.
```java
// imports...
public class App extends Application {
public void initialize(Bootstrap bootstrap) {
var migrationsBundle = new MongoMigrationsBundle() {
@Override
public String getMigrationPackage(AppConfiguration config) {
return config.getMigrationPackage();
}
@Override
public String getMongoUri(AppConfiguration config) {
return config.getMongoUri();
}
@Override
public String getDatabaseName(AppConfiguration config) {
return config.getMongoDbName();
}
@Override
public ConnectionDriver getConnectionDriver(AppConfiguration config) {
var mongoClient = MongoClients.create(getMongoUri(config));
var mongoTemplate = new MongoTemplate(mongoClient, getDatabaseName(config));
return SpringDataMongoV3Driver.withDefaultLock(mongoTemplate);
}
};
bootstrap.addBundle(migrationsBundle);
}
@Override
public void run(AppConfiguration configuration, Environment environment) {
// code to set up your application's resources, etc.
}
}
```
Once this setup is complete, add Mongock migrations to the migration package that you provided to the bundle. You can
then run `db migrate` to run pending migrations.