Protevus Mongo

MongoDB-enabled services for the Protevus framework.

Installation

Add the following to your pubspec.yaml:

dependencies:
  protevus_mongo: ^8.0.0

Usage

This library exposes one main class: MongoService.

Model

Model is class with no real functionality; however, it represents a basic document, and your services should host inherited classes. Other Protevus service providers host Model as well, so you will easily be able to modify your application if you ever switch databases.

class User extends Model {
  String username;
  String password;
}

void main() async {
    var db = Db('mongodb://localhost:27017/local');
    await db.open();
    
    var service = app.use('/api/users', MongoService(db.collection("users")));
    
    service.afterCreated.listen((event) {
        print("New user: ${event.result}");
    });
}

MongoService

This class interacts with DbCollection (from mongo_dart) and serializing data to and from Maps.

Querying

You can query these services as follows:

    /path/to/service?foo=bar

The above will query the database to find records where 'foo' equals 'bar'. The former will sort result in ascending order of creation, and so will the latter.

    List queried = await MyService.index({r"$query": where.id(ObjectId.fromHexString("some hex string"})));

And, you can use mongo_dart queries. Just pass it as query within params.

See the tests for more usage examples.

Important Notes

When connecting to a locally installed instance of MongoDB or docker based MongoDB with authentication enabled, the following connection string is not supported yet.

  var db = Db('mongodb://<username>:<password>@localhost:27017/testDB');
  await db.open();

Use the following instead. By default the user access information is stored in admin database.

  var db = Db('mongodb://localhost:27017/testDB');
  await db.open();
  await db.authenticate("<username>", "<password>", authDb: "admin");

Where

<username> is MongoDB username
<password> is MongoDB password

2.5 KiB Raw Permalink Blame History