pip_services4_mongodb

Description:

pip services4 mongodb

MongoDB components for Dart #
This module is a part of the Pip.Services polyglot microservices toolkit. It provides a set of components to implement MongoDB persistence.
The module contains the following packages:

Build - Factory to create MongoDB persistence components.
Connect - Connection component to configure MongoDB connection to database.
Persistence - abstract persistence components to perform basic CRUD operations.

Quick links:

MongoDB persistence
Configuration
API Reference
Change Log
Get Help
Contribute

Use #
Add this to your package's pubspec.yaml file:
dependencies:
pip_services4_mongodb: version
copied to clipboard
Now you can install package from the command line:
pub get
copied to clipboard
As an example, lets create persistence for the following data object.
import 'package:pip_services4_data/src/data/IIdentifiable.dart';

class MyObject implements IIdentifiable<String> {
String id;
String key;
int value;
}

copied to clipboard
The persistence component shall implement the following interface with a basic set of CRUD operations.
abstract class IMyPersistence {
void getPageByFilter(IContext? context, FilterParams filter, PagingParams paging);

getOneById(IContext? context, String id);

getOneByKey(IContext? context, String key;

create(IContext? context, MyObject item);

update(IContext? context, MyObject item);

deleteById(IContext? context, String id);
}
copied to clipboard
To implement mongodb persistence component you shall inherit IdentifiableMongoDbPersistence.
Most CRUD operations will come from the base class. You only need to override getPageByFilter method with a custom filter function.
And implement a getOneByKey custom persistence method that doesn't exist in the base class.
import 'package:pip_services4_data/src/data/FilterParams.dart';
import 'package:pip_services4_data/src/data/PagingParams.dart';
import 'package:pip_services4_mongodb/src/persistence/IdentifiableMongoDbPersistence.dart';


class MyMongoDbPersistence extends IdentifiableMongoDbPersistence {
MyMongoDbPersistence():super("myobjects"){
this.ensureIndex({{ "key": 1 }, { "unique": true }});
}

composeFilter(FilterParams filter) {
filter = filter!=null ? filter : new FilterParams();

List criteria = [];

String id = filter.getAsNullableString('id');
if (id != null)
criteria.add({ "_id": id });

String tempIds = filter.getAsNullableString("ids");
if (tempIds != null) {
List ids = tempIds.split(",");
criteria.add({ "_id": { "\$in": ids } });
}

String key = filter.getAsNullableString("key");
if (key != null)
criteria.add({ "key": key });

return criteria.length > 0 ? { "\$and": criteria } : null;
}

Future<DataPage<MyData>> getPageByFilter(IContext? context, FilterParams filter, PagingParams paging){
return super.getPageByFilterEx(context, composeFilter(filter), paging, null);
}

getOneByKey(IContext? context, String key) async {

Map<String, String> filter = { key: key };

Map<String, dynamic> item = await this.collection.findOne(filter);

if (item == null)
this.logger.trace(context, "Nothing found from %s with key = %s", [this.collectionName, key]);
else
this.logger.trace(context, "Retrieved from %s with key = %s", [this.collectionName, key]);

item = this.convertToPublic(item);
}
}
copied to clipboard
Configuration for your microservice that includes mongodb persistence may look the following way.
...
{{#if MONGODB_ENABLED}}
- descriptor: pip-services:connection:mongodb:con1:1.0
connection:
uri: {{{MONGO_SERVICE_URI}}}
host: {{{MONGO_SERVICE_HOST}}}{{#unless MONGO_SERVICE_HOST}}localhost{{/unless}}
port: {{MONGO_SERVICE_PORT}}{{#unless MONGO_SERVICE_PORT}}27017{{/unless}}
database: {{MONGO_DB}}{{#unless MONGO_DB}}app{{/unless}}
credential:
username: {{MONGO_USER}}
password: {{MONGO_PASS}}

- descriptor: myservice:persistence:mongodb:default:1.0
dependencies:
connection: pip-services:connection:mongodb:con1:1.0
collection: {{MONGO_COLLECTION}}{{#unless MONGO_COLLECTION}}myobjects{{/unless}}
{{/if}}
...
copied to clipboard
Develop #
For development you shall install the following prerequisites:

Dart SDK 3
Visual Studio Code or another IDE of your choice
Docker

Install dependencies:
pub get
copied to clipboard
Run automated tests:
pub run test
copied to clipboard
Generate API documentation:
./docgen.ps1
copied to clipboard
Before committing changes run dockerized build and test as:
./build.ps1
./test.ps1
./clear.ps1
copied to clipboard
Contacts #
The library is created and maintained by

Sergey Seroukhov
Levichev Dmitry.

The documentation is written by

Mark Makarychev
Levichev Dmitry.