angel_mongo 2.0.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 82

angel_mongo #

Pub build status

MongoDB-enabled services for the Angel framework.

Installation #

Add the following to your pubspec.yaml:

dependencies:
  angel_mongo: ^2.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 {
    var db = new Db('mongodb://localhost:27017/local');
    await db.open();
    
    var service = app.use('/api/users', new MongoService(db.collection("users")));
    
    service.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.

2.0.3 #

2.0.2 #

  • Fix flaw where clients could remove all records, even if allowRemoveAll were false.

2.0.1 #

  • Override readMany and findOne.

2.0.0- #

  • Delete mongo_service_typed.
  • Update for Angel 2.

example/example.dart

import 'package:angel_framework/angel_framework.dart';
import 'package:angel_mongo/angel_mongo.dart';
import 'package:mongo_dart/mongo_dart.dart';

main() async {
  var app = new Angel();
  Db db = new Db('mongodb://localhost:27017/local');
  await db.open();

  var service = app.use('/api/users', new MongoService(db.collection("users")));

  service.afterCreated.listen((event) {
    print("New user: ${event.result}");
  });
}

Use this package as a library

1. Depend on it

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


dependencies:
  angel_mongo: ^2.0.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter 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';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
68
Health:
Code health derived from static analysis. [more]
93
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
82
Learn more about scoring.

We analyzed this package on Dec 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.0
  • pana: 0.13.1+4

Health suggestions

Fix lib/mongo_service.dart. (-4.89 points)

Analysis of lib/mongo_service.dart reported 10 hints, including:

line 19 col 16: Don't type annotate initializing formals.

line 24 col 18: Unnecessary new keyword.

line 112 col 13: Unnecessary new keyword.

line 124 col 13: Unnecessary new keyword.

line 137 col 13: Unnecessary new keyword.

Fix lib/services.dart. (-2.48 points)

Analysis of lib/services.dart reported 5 hints:

line 11 col 16: Unnecessary new keyword.

line 21 col 36: Unnecessary new keyword.

line 23 col 11: Unnecessary new keyword.

line 27 col 43: Avoid const keyword.

line 40 col 32: Avoid const keyword.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
angel_framework ^2.0.0-alpha 2.1.0
json_god >=2.0.0-beta <3.0.0 2.0.0-beta+3
merge_map ^1.0.0 1.0.2
mongo_dart >=0.2.7 <1.0.0 0.4.0
Transitive dependencies
angel_container 1.1.0
angel_http_exception 1.1.0
angel_model 1.0.3
angel_route 3.1.0+1
async 2.4.0
bson 0.3.2
charcode 1.1.2
code_buffer 1.0.1
collection 1.14.12
combinator 1.1.0
convert 2.1.1
crypto 2.1.4
dart2_constant 1.0.2+dart2
file 5.1.0
fixnum 0.10.11
http2 1.0.0
http_parser 3.1.3
http_server 0.9.8+3
intl 0.16.0
logging 0.11.3+2
matcher 0.12.6
meta 1.1.8
mime 0.9.6+3
mock_request 1.0.6
mongo_dart_query 0.4.1
more 1.18.2 2.0.1
path 1.6.4
pool 1.4.0
quiver 2.1.2+1
quiver_hashcode 2.0.0
recase 2.0.1
source_span 1.5.5
stack_trace 1.9.3
string_scanner 1.0.5
term_glyph 1.1.0
tuple 1.0.3
typed_data 1.1.6
uuid 2.0.4
Dev dependencies
http >=0.11.3 <0.12.0
pedantic ^1.0.0 1.9.0
test ^1.0.0