Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xakep666/mongo-migrate
Versioned migrations for MongoDB.
https://github.com/xakep666/mongo-migrate
database-management database-migrations golang mgo migrations mongodb versioned-migrations
Last synced: 3 months ago
JSON representation
Versioned migrations for MongoDB.
- Host: GitHub
- URL: https://github.com/xakep666/mongo-migrate
- Owner: xakep666
- License: mit
- Created: 2018-08-21T07:45:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T17:38:31.000Z (10 months ago)
- Last Synced: 2024-04-02T18:46:55.949Z (10 months ago)
- Topics: database-management, database-migrations, golang, mgo, migrations, mongodb, versioned-migrations
- Language: Go
- Homepage:
- Size: 81.1 KB
- Stars: 98
- Watchers: 5
- Forks: 45
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Versioned migrations for MongoDB
[](https://travis-ci.org/xakep666/mongo-migrate)
[](https://codecov.io/gh/xakep666/mongo-migrate)
[](https://goreportcard.com/report/github.com/xakep666/mongo-migrate)
[](https://godoc.org/github.com/xakep666/mongo-migrate)
[](https://opensource.org/licenses/MIT)
This package allows to perform versioned migrations on your MongoDB using [mongo-go-driver](https://github.com/mongodb/mongo-go-driver).
Inspired by [go-pg migrations](https://github.com/go-pg/migrations).
Table of Contents
=================
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Use case \#1\. Migrations in files\.](#use-case-1-migrations-in-files)
* [Use case \#2\. Migrations in application code\.](#use-case-2-migrations-in-application-code)
* [How it works?](#how-it-works)
* [License](#license)
## Prerequisites
* Golang >= 1.22
## Installation
```bash
go get -v -u github.com/xakep666/mongo-migrate
```
## Usage
### Use case #1. Migrations in files.
* Create a package with migration files.
File name should be like `_.go`.
`1_add-my-index.go`
```go
package migrations
import (
"context"
"go.mongodb.org/mongo-driver/v2/bson"
"go.mongodb.org/mongo-driver/v2/mongo"
"go.mongodb.org/mongo-driver/v2/mongo/options"
migrate "github.com/xakep666/mongo-migrate"
)
func init() {
migrate.MustRegister(func(ctx context.Context, db *mongo.Database) error {
opt := options.Index().SetName("my-index")
keys := bson.D{{Key: "my-key", Value: 1}}
model := mongo.IndexModel{Keys: keys, Options: opt}
_, err := db.Collection("my-coll").Indexes().CreateOne(ctx, model)
if err != nil {
return err
}
return nil
}, func(ctx context.Context, db *mongo.Database) error {
err := db.Collection("my-coll").Indexes().DropOne(ctx, "my-index")
if err != nil {
return err
}
return nil
})
}
```
* Import it in your application.
```go
import (
...
migrate "github.com/xakep666/mongo-migrate"
_ "path/to/migrations_package" // database migrations
...
)
```
* Run migrations.
```go
func MongoConnect(host, user, password, database string) (*mongo.Database, error) {
uri := fmt.Sprintf("mongodb://%s:%s@%s:27017", user, password, host)
opt := options.Client().ApplyURI(addr.String())
client, err := mongo.Connect(opt)
if err != nil {
return nil, err
}
db := client.Database(database)
migrate.SetDatabase(db)
if err := migrate.Up(ctx, migrate.AllAvailable); err != nil {
return nil, err
}
return db, nil
}
```
### Use case #2. Migrations in application code.
* Just define it anywhere you want and run it.
```go
func MongoConnect(host, user, password, database string) (*mongo.Database, error) {
uri := fmt.Sprintf("mongodb://%s:%s@%s:27017", user, password, host)
opt := options.Client().ApplyURI(uri)
err = mongo.Connect(opt)
if err != nil {
return nil, err
}
db = client.Database(database)
m := migrate.NewMigrate(db, migrate.Migration{
Version: 1,
Description: "add my-index",
Up: func(ctx context.Context, db *mongo.Database) error {
opt := options.Index().SetName("my-index")
keys := bson.D{{"my-key", 1}}
model := mongo.IndexModel{Keys: keys, Options: opt}
_, err := db.Collection("my-coll").Indexes().CreateOne(ctx, model)
if err != nil {
return err
}
return nil
},
Down: func(ctx context.Context, db *mongo.Database) error {
_, err := db.Collection("my-coll").Indexes().DropOne(ctx, "my-index")
if err != nil {
return err
}
return nil
},
})
if err := m.Up(ctx, migrate.AllAvailable); err != nil {
return nil, err
}
return db, nil
}
```
## How it works?
This package creates a special collection (by default it`s name is "migrations") for versioning.
In this collection stored documents like
```json
{
"_id": "",
"version": 1,
"description": "add my-index",
"timestamp": ""
}
```
Current database version determined as version from latest inserted document.
You can change collection name using `SetMigrationsCollection` methods.
Remember that if you want to use custom collection name you need to set it before running migrations.
## License
mongo-migrate project is licensed under the terms of the MIT license. Please see LICENSE in this repository for more details.