Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mycodeself/mongo-migrate-ts
Run mongodb migrations easy from TypeScript
https://github.com/mycodeself/mongo-migrate-ts
database migrations mongo-migrate mongodb npm typescript
Last synced: 1 day ago
JSON representation
Run mongodb migrations easy from TypeScript
- Host: GitHub
- URL: https://github.com/mycodeself/mongo-migrate-ts
- Owner: mycodeself
- License: mit
- Created: 2019-10-20T17:27:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T22:45:54.000Z (about 1 month ago)
- Last Synced: 2024-12-15T10:03:05.682Z (8 days ago)
- Topics: database, migrations, mongo-migrate, mongodb, npm, typescript
- Language: TypeScript
- Homepage:
- Size: 1.65 MB
- Stars: 90
- Watchers: 2
- Forks: 28
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# mongo-migrate-ts
[](https://circleci.com/gh/mycodeself/mongo-migrate-ts)
A library for easy run migrations on mongodb with TypeScript.
Based on migrate-mongo (https://github.com/seppevs/migrate-mongo/), but with TypeScript support.
## Installation
Install using your favourite package manager, example using npm
```
npm install mongo-migrate-ts
```
You can install it globally for the CLI usage
```
npm install -g mongo-migrate-ts
```
## Usage
### CLI options
```
Usage: mongo-migrate [options] [command]
Options:
-h, --help output usage information
Commands:
init Creates the migrations directory and configuration file
new [options] Create a new migration file under migrations directory
up Run all pending migrations
down [options] Undo migrations
status Show the status of the migrations
```
Create a directory for your migrations.
```bash
mongo-migrate init
```
Instantiate a CLI within the newly created migrations directory
```typescript
// index.ts in this example
import { mongoMigrateCli } from 'mongo-migrate-ts';
mongoMigrateCli({
uri: 'mongodb://username:[email protected]:27017',
database: 'db',
migrationsDir: __dirname,
migrationsCollection: 'migrations_collection',
});
```
Create a migration file in the configured migrations folder...
```bash
mongo-migrate new
```
```typescript
import { MigrationInterface } from 'mongo-migrate-ts';
import { Db, MongoClient } from 'mongodb';
export class MyMigration implements MigrationInterface {
async up(db: Db, client: MongoClient): Promise {
await db.createCollection('my_collection');
}
async down(db: Db, client: MongoClient): Promise {
await db.dropCollection('my_collection');
}
}
```
Compile and up all migrations
```
tsc migrations/index.js && node build/migrations/index.js up
```
or run directly with ts-node
```
ts-node migrations/index.ts up
```
## Configuration
```typescript
{
// The path where the migrations are stored
migrationsDir: string;
// The name of the collection to store the applied migrations
// (Default: "migrations_changelog")
migrationsCollection?: string;
// The glob pattern for migration scripts
// (Default: isTsNode() ? '**/*.ts' : '**/*.js'
globPattern?: string;
// The glob options for pattern matching
// (see https://github.com/isaacs/node-glob#options)
// (Default: { cwd: migrationsDir })
globOptions?: string;
// The connection uri, it can be empty if useEnv is true
// (Example: mongodb://user:[email protected]:27017/db?authSource=admin)
uri?: string;
// The database where run the migrations
// it can be empty if the database is on the uri or useEnv is true
database?: string;
// If true, will load the configuration from environment variables.
useEnv?: boolean;
// Options related to environment configuration
environment?: {
// The name of the environment variable with the uri connection
// (Default: MONGO_MIGRATE_URI)
uriVar?: string;
// The name of the environment variable with the db name
// (Default: MONGO_MIGRATE_DB)
databaseVar?: string;
};
// The format pattern for timestamp in the migration file name. By default: 'T'
// (see https://date-fns.org/v2.30.0/docs/format)
migrationNameTimestampFormat?: string;
// Specific configuration of mongodb client
// (see https://mongodb.github.io/node-mongodb-native/4.3/interfaces/MongoClientOptions.html)
options?: MongoClientOptions;
}
```
Example configuration in json
```json
{
"uri": "mongodb://admin:[email protected]:27017/mydb?authSource=admin",
"migrationsDir": "migrations",
"migrationNameTimestampFormat": "yyyyMMddHHmmss"
}
```
## Transactions
The `up` and `down` methods in migrations have the mongo client available to create a session and use transactions. See example
```typescript
import { Db, MongoClient } from 'mongodb';
import { MigrationInterface } from '../../lib';
export class Transaction1691171075957 implements MigrationInterface {
public async up(db: Db, client: MongoClient): Promise {
const session = client.startSession();
try {
await session.withTransaction(async () => {
await db.collection('mycol').insertOne({ foo: 'one' });
await db.collection('mycol').insertOne({ foo: 'two' });
await db.collection('mycol').insertOne({ foo: 'three' });
});
} finally {
await session.endSession();
}
}
public async down(db: Db, client: MongoClient): Promise {
const session = client.startSession();
try {
await session.withTransaction(async () => {
await db.collection('mycol').deleteOne({ foo: 'one' });
await db.collection('mycol').deleteOne({ foo: 'two' });
await db.collection('mycol').deleteOne({ foo: 'three' });
});
} finally {
await session.endSession();
}
}
}
```