angel_mongo 1.1.6

  • README.md
  • Installing
  • Versions
  • 68

angel_mongo

Pub build status

MongoDB-enabled services for the Angel framework.

Installation

Add the following to your pubspec.yaml:

dependencies:
  angel_mongo: ^1.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 Angel 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;
}

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

MongoService

This class interacts with a 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(new ObjectId.fromHexString("some hex string"})));

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

See the tests for more usage examples.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  angel_mongo: ^1.1.6

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:angel_mongo/angel_mongo.dart';
  
Version Uploaded Documentation Archive
1.1.6 Jul 9, 2017 Go to the documentation of angel_mongo 1.1.6 Download angel_mongo 1.1.6 archive
1.1.5 Apr 10, 2017 Go to the documentation of angel_mongo 1.1.5 Download angel_mongo 1.1.5 archive
1.1.4 Feb 23, 2017 Go to the documentation of angel_mongo 1.1.4 Download angel_mongo 1.1.4 archive
1.1.3 Feb 23, 2017 Go to the documentation of angel_mongo 1.1.3 Download angel_mongo 1.1.3 archive
1.1.2 Feb 20, 2017 Go to the documentation of angel_mongo 1.1.2 Download angel_mongo 1.1.2 archive
1.1.1 Feb 20, 2017 Go to the documentation of angel_mongo 1.1.1 Download angel_mongo 1.1.1 archive
1.1.0 Feb 19, 2017 Go to the documentation of angel_mongo 1.1.0 Download angel_mongo 1.1.0 archive
1.0.0-dev+6 Dec 3, 2016 Go to the documentation of angel_mongo 1.0.0-dev+6 Download angel_mongo 1.0.0-dev+6 archive
1.0.0-dev+5 Dec 3, 2016 Go to the documentation of angel_mongo 1.0.0-dev+5 Download angel_mongo 1.0.0-dev+5 archive
1.0.0-dev+4 Dec 3, 2016 Go to the documentation of angel_mongo 1.0.0-dev+4 Download angel_mongo 1.0.0-dev+4 archive

All 14 versions...

Popularity:
Describes how popular the package is relative to other packages. [more]
56
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
54
Overall:
Weighted score of the above. [more]
68
Learn more about scoring.

We analyzed this package on Aug 15, 2018, and provided a score, details, and suggestions below. Analysis was completed with status tool failures using:

  • Dart: 2.0.0
  • pana: 0.11.8

Platforms

Detected platforms: unsure

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Issues and suggestions

Fix dependencies in pubspec.yaml.

Running pub upgrade failed with the following output:

ERR: The current Dart SDK version is 2.0.0.
 
 Because angel_framework >=0.0.0-dev.1 <1.1.3 requires SDK version <2.0.0 and angel_framework >=1.1.3 depends on random_string ^0.0.1, angel_framework >=0.0.0-dev.1 requires random_string ^0.0.1.
 So, because every version of random_string requires SDK version >=1.0.0 <2.0.0 and angel_mongo depends on angel_framework ^1.0.0-dev, version solving failed.

Fix platform conflicts.

Error(s) prevent platform classification:

Fix dependencies in pubspec.yaml.

Maintain CHANGELOG.md.

Changelog entries help clients to follow the progress in your code.

Add SDK constraint in pubspec.yaml.

For information about setting SDK constraint, please see https://www.dartlang.org/tools/pub/pubspec#sdk-constraints.

Package is getting outdated.

The package was released 57 weeks ago.

The description is too short.

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Maintain an example.

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use angel_mongo.dart.

Format lib/angel_mongo.dart.

Run dartfmt to format lib/angel_mongo.dart.

Format lib/model.dart.

Run dartfmt to format lib/model.dart.