Soap MongoDB

This page and the plugin itself are still in development, a lot will change.

@soapjs/soap-node-mongo is the MongoDB integration: a Source implementation (MongoSource), a query factory, and connection management.

Current version: 0.7.x. Peer deps: @soapjs/soap ≥ 0.10, mongodb.

Install

npm install @soapjs/soap-node-mongo mongodb

Connect

import { SoapMongo, MongoConfig, MongoSource } from '@soapjs/soap-node-mongo';

const config = new MongoConfig('mydb', ['localhost'], ['27017'], user, password);
const soapMongo = await SoapMongo.create(config);

Source

MongoSource implements the full Source contract and is wrapped in a DatabaseContext for a repository:

import { DatabaseContext } from '@soapjs/soap';

const source = new MongoSource(soapMongo, 'characters');
const context = new DatabaseContext(source, new CharacterMapper(), soapMongo.sessions);

Methods: find · count · aggregate · insert · update · remove · native.

Queries

• find / count take FindParams / CountParams built with Where; the query factory translates Where into a MongoDB filter — no Mongo syntax in your repo.

• aggregate runs a portable AggregationParams (groupBy, sum, where, …).

Native queries

For pipelines, commands, or operators the abstraction can't express, use native() with a RepositoryQuery whose build() returns the raw payload:

build() returns	Runs as
an array	aggregation pipeline
{ kind: 'find', filter, options? }	collection.find
{ kind: 'command', command }	db.command

See Using Native Queries.

Read/write split

Set readPreference in the connection pool config and use a separate MongoSource per connection (read replica vs primary). See the demo.