angel_mongo 2.0.0

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 64

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.0-rc.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.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages 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
2.0.0 Oct 18, 2018 Go to the documentation of angel_mongo 2.0.0 Download angel_mongo 2.0.0 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
2.0.0-rc.0 Oct 18, 2018 Go to the documentation of angel_mongo 2.0.0-rc.0 Download angel_mongo 2.0.0-rc.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

All 16 versions...

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

We analyzed this package on Oct 19, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.4

Platforms

Detected platforms: Flutter, other

Primary library: package:angel_mongo/angel_mongo.dart with components: io.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <3.0.0
angel_framework ^2.0.0-alpha 2.0.0-alpha.5
json_god >=2.0.0-beta <3.0.0 2.0.0-beta+3
merge_map ^1.0.0 1.0.1
mongo_dart >=0.2.7 <1.0.0 0.3.3
Transitive dependencies
angel_container 1.0.0-alpha.9
angel_http_exception 1.0.0+3
angel_model 1.0.0+1
angel_route 3.0.0
async 2.0.8
body_parser 1.1.1
bson 0.3.2
charcode 1.1.2
code_buffer 1.0.1
collection 1.14.11
combinator 1.0.0+3
convert 2.0.2
crypto 2.0.6
dart2_constant 1.0.2+dart2
file 5.0.6
fixnum 0.10.8
http_parser 3.1.3
http_server 0.9.8
intl 0.15.7
logging 0.11.3+2
matcher 0.12.4
meta 1.1.6
mime 0.9.6+2
mongo_dart_query 0.3.2
more 1.12.1
path 1.6.2
pool 1.3.6
quiver 2.0.0+1
source_span 1.4.1
stack_trace 1.9.3
string_scanner 1.0.4
tuple 1.0.2
typed_data 1.1.6
uuid 1.0.3
Dev dependencies
http >=0.11.3 <0.12.0
test ^1.0.0