angel_orm 2.0.0-dev.14

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

angel_orm

Runtime support for Angel's ORM. Includes a clean, database-agnostic query builder and relationship/join support.

For documentation about the ORM, head to the main project repo: https://github.com/angel-dart/orm

2.0.0-dev.14

  • Remove obsolete @belongsToMany.

2.0.0-dev.13

  • Push for consistency with orm_gen @ 2.0.0-dev.

2.0.0-dev.12

  • Always apply toSql escapes.

2.0.0-dev.11

  • Remove limit(1) except on getOne

2.0.0-dev.10

  • Add withFields to compile()

2.0.0-dev.9

  • Permanent preamble fix

2.0.0-dev.8

  • Escapes

2.0.0-dev.7

  • Update toSql
  • Add isTrue and isFalse

2.0.0-dev.6

  • Add delete, insert and update methods to Query.

2.0.0-dev.4

  • Add more querying methods.
  • Add preamble to Query.compile.

2.0.0-dev.3

  • Brought back old-style query builder.
  • Strong-mode updates, revised Join.

2.0.0-dev.2

  • Renamed ORM to Orm.
  • Orm now requires a database type.

2.0.0-dev.1

  • Restored all old PostgreSQL-specific annotations. Rather than a smart runtime, having a codegen capable of building ORM's for multiple databases can potentially provide a very fast ORM for everyone.

2.0.0-dev

  • Removed PostgreSQL-specific functionality, so that the ORM can ultimately target all services.
  • Created a better Join model.
  • Created a far better Query model.
  • Removed lib/server.dart

1.0.0-alpha+10

  • Split into angel_orm.dart and server.dart. Prevents DDC failures.

1.0.0-alpha+7

  • Added a @belongsToMany annotation class.
  • Resolved #20. The PostgreSQLConnectionPool keeps track of which connections have been opened now.

1.0.0-alpha+6

  • DateTimeSqlExpressionBuilder will no longer automatically insert quotation marks around names.

1.0.0-alpha+5

  • Corrected a typo that was causing the aforementioned test failures. == becomes =.

1.0.0-alpha+4

  • Added a null-check in lib/src/query.dart#L24 to (hopefully) prevent it from crashing on Travis.

1.0.0-alpha+3

  • Added isIn, isNotIn, isBetween, isNotBetween to SqlExpressionBuilder and its subclasses.
  • Added a dependency on package:meta.

example/main.dart

import 'dart:async';

import 'package:angel_model/angel_model.dart';
import 'package:angel_orm/angel_orm.dart';
import 'package:angel_orm/src/query.dart';
import 'package:angel_serialize/angel_serialize.dart';
part 'main.g.dart';
part 'main.serializer.g.dart';

main() async {
  var query = new EmployeeQuery()
    ..where.firstName.equals('Rich')
    ..where.lastName.equals('Person')
    ..orWhere((w) => w.salary.greaterThanOrEqualTo(75000))
    ..join('companies', 'company_id', 'id');

  var richPerson = await query.getOne(new _FakeExecutor());
  print(richPerson.toJson());
}

class _FakeExecutor extends QueryExecutor {
  const _FakeExecutor();

  @override
  Future<List<List>> query(String query, [returningFields]) async {
    var now = new DateTime.now();
    print('_FakeExecutor received query: $query');
    return [
      [1, 'Rich', 'Person', 100000.0, now, now]
    ];
  }

  @override
  Future<T> transaction<T>(FutureOr<T> Function() f) {
    throw new UnsupportedError('Transactions are not supported.');
  }
}

@orm
@serializable
abstract class _Employee extends Model {
  String get firstName;

  String get lastName;

  double get salary;
}

class EmployeeQuery extends Query<Employee, EmployeeQueryWhere> {
  @override
  final QueryValues values = new MapQueryValues();

  @override
  final EmployeeQueryWhere where = new EmployeeQueryWhere();

  @override
  String get tableName => 'employees';

  @override
  List<String> get fields =>
      ['id', 'first_name', 'last_name', 'salary', 'created_at', 'updated_at'];

  @override
  Employee deserialize(List row) {
    return new Employee(
        id: row[0].toString(),
        firstName: row[1] as String,
        lastName: row[2] as String,
        salary: row[3] as double,
        createdAt: row[4] as DateTime,
        updatedAt: row[5] as DateTime);
  }
}

class EmployeeQueryWhere extends QueryWhere {
  @override
  Iterable<SqlExpressionBuilder> get expressionBuilders {
    return [id, firstName, lastName, salary, createdAt, updatedAt];
  }

  final NumericSqlExpressionBuilder<int> id =
      new NumericSqlExpressionBuilder<int>('id');

  final StringSqlExpressionBuilder firstName =
      new StringSqlExpressionBuilder('first_name');

  final StringSqlExpressionBuilder lastName =
      new StringSqlExpressionBuilder('last_name');

  final NumericSqlExpressionBuilder<double> salary =
      new NumericSqlExpressionBuilder<double>('salary');

  final DateTimeSqlExpressionBuilder createdAt =
      new DateTimeSqlExpressionBuilder('created_at');

  final DateTimeSqlExpressionBuilder updatedAt =
      new DateTimeSqlExpressionBuilder('updated_at');
}

Use this package as a library

1. Depend on it

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


dependencies:
  angel_orm: ^2.0.0-dev.14

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_orm/angel_orm.dart';
  
Version Uploaded Documentation Archive
2.0.0-dev.14 Dec 8, 2018 Go to the documentation of angel_orm 2.0.0-dev.14 Download angel_orm 2.0.0-dev.14 archive
2.0.0-dev.13 Dec 8, 2018 Go to the documentation of angel_orm 2.0.0-dev.13 Download angel_orm 2.0.0-dev.13 archive
2.0.0-dev.12 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.12 Download angel_orm 2.0.0-dev.12 archive
2.0.0-dev.11 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.11 Download angel_orm 2.0.0-dev.11 archive
2.0.0-dev.10 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.10 Download angel_orm 2.0.0-dev.10 archive
2.0.0-dev.9 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.9 Download angel_orm 2.0.0-dev.9 archive
2.0.0-dev.8 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.8 Download angel_orm 2.0.0-dev.8 archive
2.0.0-dev.7 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.7 Download angel_orm 2.0.0-dev.7 archive
2.0.0-dev.6 Dec 3, 2018 Go to the documentation of angel_orm 2.0.0-dev.6 Download angel_orm 2.0.0-dev.6 archive
2.0.0-dev.5 Dec 1, 2018 Go to the documentation of angel_orm 2.0.0-dev.5 Download angel_orm 2.0.0-dev.5 archive

All 28 versions...

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

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

  • Dart: 2.1.0
  • pana: 0.12.7

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:angel_orm/angel_orm.dart.

Maintenance suggestions

Package is pre-release. (-5 points)

Pre-release versions should be used with caution, their API may change in breaking ways.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.1.2 <3.0.0
charcode ^1.0.0 1.1.2
intl ^0.15.7 0.15.7
meta ^1.0.0 1.1.6
string_scanner ^1.0.0 1.0.4
Transitive dependencies
path 1.6.2
source_span 1.4.1
Dev dependencies
angel_model ^1.0.0
angel_serialize ^2.0.0
angel_serialize_generator ^2.0.0
build_runner ^1.0.0
test ^1.0.0