@jperezmart/nest-mongodb

Native MongoDB driver integration for NestJS — the same surface as @nestjs/mongoose, but using the official mongodb driver (MongoClient / Db / Collection) instead of an ODM. Ships ESM + CJS with type definitions for both.

Why

@nestjs/mongoose is great, but Mongoose brings schemas, hooks, plugins and discriminators you may not want. This package keeps the ergonomic NestJS module API — forRoot, forFeature, injection decorators, connection retry and clean shutdown — and hands you the raw driver objects.

Install

pnpm add @jperezmart/nest-mongodb mongodb

@nestjs/common, @nestjs/core, reflect-metadata and rxjs are peer dependencies (you already have them in a Nest app).

API at a glance (vs @nestjs/mongoose)

| @nestjs/mongoose | @jperezmart/nest-mongodb | | ----------------------------------- | -------------------------------------------- | | MongooseModule.forRoot(uri, opts) | MongoModule.forRoot(uri, opts) | | MongooseModule.forRootAsync(opts) | MongoModule.forRootAsync(opts) | | MongooseModule.forFeature(models) | MongoModule.forFeature(collections) | | @InjectConnection() | @InjectClient() (sessions) / @InjectDb() | | @InjectModel('Cat') | @InjectCollection('cats') | | connection.startSession() | MongoTransactionService.withTransaction() |

Option names and defaults mirror @nestjs/mongoose: retryAttempts (default 9), retryDelay (default 3000 ms), connectionName, connectionFactory, connectionErrorFactory, lazyConnection, onConnectionCreate, verboseRetryLog, plus dbName and any MongoClientOptions inline.

Usage

Root connection

import { MongoModule } from '@jperezmart/nest-mongodb';

@Module({
  imports: [
    MongoModule.forRoot('mongodb://localhost:27017', { dbName: 'app' }),
  ],
})
export class AppModule {}

Async configuration:

MongoModule.forRootAsync({
  imports: [ConfigModule],
  inject: [ConfigService],
  useFactory: (config: ConfigService) => ({
    uri: config.getOrThrow('MONGO_URI'),
    dbName: 'app',
  }),
});

Enable shutdown hooks so the client closes on exit:

const app = await NestFactory.create(AppModule);
app.enableShutdownHooks();

Collections

import { MongoModule } from '@jperezmart/nest-mongodb';

@Module({ imports: [MongoModule.forFeature(['cats'])] })
export class CatsModule {}

import { InjectCollection } from '@jperezmart/nest-mongodb';
import type { Collection } from 'mongodb';

@Injectable()
export class CatsService {
  constructor(
    @InjectCollection('cats') private readonly cats: Collection<Cat>,
  ) {}

  findAll() {
    return this.cats.find().toArray();
  }
}

forFeature also accepts full definitions and a connection name:

MongoModule.forFeature([
  { name: 'cats', options: { readPreference: 'secondary' } },
]);
MongoModule.forFeature(['events'], 'analytics');

Transactions

Requires a replica set (or mongos). withTransaction commits on success and aborts + rethrows on error:

import { MongoTransactionService } from '@jperezmart/nest-mongodb';

@Injectable()
export class BankService {
  constructor(
    @InjectCollection('accounts')
    private readonly accounts: Collection<Account>,
    private readonly tx: MongoTransactionService,
  ) {}

  transfer(from: string, to: string, amount: number) {
    return this.tx.withTransaction(async session => {
      await this.accounts.updateOne(
        { _id: from },
        { $inc: { balance: -amount } },
        { session },
      );
      await this.accounts.updateOne(
        { _id: to },
        { $inc: { balance: amount } },
        { session },
      );
    });
  }
}

Multiple connections

MongoModule.forRoot('mongodb://primary', { dbName: 'app' });
MongoModule.forRoot('mongodb://analytics', {
  dbName: 'metrics',
  connectionName: 'analytics',
});

constructor(
  @InjectClient('analytics') private readonly client: MongoClient,
  @InjectDb('analytics') private readonly db: Db,
) {}

MongoTransactionService is bound to the default connection. For a named connection, inject its client with @InjectClient(name) and call startSession() yourself.

License

MIT