angel3_orm_generator 10.0.0

Code generators for Angel3 ORM. Generates query builder classes.

Angel3 ORM Generator

The builder for generating the following code for Angel3 ORM:

• Strongly-typed ORM classes
• SQL migration classes

For documentation about the ORM, see Developer Guide

Installation

In your pubspec.yaml:

dependencies:
  angel3_orm: ^10.0.0
  angel3_serialize: ^10.0.0
  angel3_migration: ^10.0.0
dev_dependencies:
  angel3_orm_generator: ^10.0.0
  build_runner: ^2.4.0

Models

Name a model class with the Entity suffix, such as CarEntity. The generated classes are named without it: Car, CarQuery, CarQueryWhere, CarQueryValues and CarMigration, and the table is cars.

A class with the _ prefix, such as _Car, generates the same classes. A class with both, such as _CarEntity, also generates Car, but keeps the table, car_entities, that versions before 10.0.0 gave it.

Usage

Annotate a model with @serializable and @orm, in car.dart:

import 'package:angel3_migration/angel3_migration.dart';
import 'package:angel3_orm/angel3_orm.dart';
import 'package:angel3_serialize/angel3_serialize.dart';
import 'package:optional/optional.dart';

part 'car.g.dart';

@serializable
@orm
abstract class CarEntity extends Model {
  String? get make;

  bool? get familyFriendly;
}

Run the following command to generate the required .g.dart files for Angel3 ORM.

    dart run build_runner build

Supported database

• PostgreSQL version 14 or later
• MariaDB 10.2.x or later
• MySQL 8.x or later

Migrating from 9.x to 10.0.0

The breaking changes of each release are listed in the CHANGELOG. Those of 10.0.0 that may need changes in an app:

• Regenerate your models with dart run build_runner build --delete-conflicting-outputs, with angel3_orm 10.

• Relations: @HasMany and @ManyToMany are loaded with a query each instead of joins. A generated query no longer overrides get, update, delete or canCompile, and overrides loadRelations and loadsRelations instead; code that called the old overrides directly needs no change. See Migrating from 9.x to 10.0.0 of angel3_orm.

• Relation keys: the key of a relation in QueryValues, such as authorId of a @BelongsTo AuthorEntity author, is nullable (int?):

  // 9.x
  int authorId = query.values.authorId;
  
  // 10.0.0
  int? authorId = query.values.authorId;
  

• Code that uses the generator's API: OrmBuildContext.effectiveFields is a List<OrmField> (ClassOrmField or RelationFieldImpl), as are the arguments of findPrimaryFieldInList, isSpecialId, findLocalField and findForeignField.