dorm library

DORM - Dart Object-Relational Mapping

A powerful ORM for Dart inspired by Hibernate and Entity Framework. Supports PostgreSQL, MySQL, and SQLite with LINQ-style queries.

Classes

Check
Check constraint annotation
CheckConstraint
Check constraint definition
Column
Column annotation for customizing field-to-column mapping
ColumnSchema
Column schema definition
CompositeMigration
A migration that combines multiple migrations into one
DatabaseConfig
Database configuration
DatabaseConnection
Abstract database connection interface Supports PostgreSQL, MySQL, and SQLite
DatabaseConnectionPool
Connection pool for managing multiple database connections
DatabaseFactory
Factory for creating database connections
DatabaseMigration
DatabaseSchema
Database schema representation for entities
DatabaseTransaction
Transaction interface
Db
Database annotation for generating a database class with repositories
DbConfig
Database configuration for @Db annotation
Entity
Entity annotation for marking a class as a database entity
ForeignKey
Foreign key definition
ForeignKeyConstraint
Foreign key constraint annotation for defining foreign key constraints
Id
Id annotation for marking a single field as the primary key.
Ignore
Ignore annotation for excluding a field from database mapping
Index
Index annotation for creating database indexes
IndexSchema
Index schema definition
JoinColumn
Column configuration for junction table foreign keys
JoinTable
Junction table configuration for ManyToMany relationships
JunctionColumn
Custom column for junction tables
ManualMigration
A migration that uses callbacks for up/down operations
ManyToMany
ManyToMany relationship annotation
ManyToOne
ManyToOne relationship annotation
MigrationRunner
MySQLConnection
MySQL implementation of DatabaseConnection Note: Requires mysql1 package: Add "mysql1: ^0.20.0" to pubspec.yaml
MySQLTransaction
MySQL transaction implementation
OneToMany
OneToMany relationship annotation
OneToOne
OneToOne relationship annotation
PostgreSQLConnection
PostgreSQL implementation of DatabaseConnection
PostgreSQLTransaction
PostgreSQL transaction implementation
PrimaryKey
Primary key annotation for composite primary keys (multiple columns).
Query
Raw query annotation for custom SQL queries
QueryBuilder<T>
EntityFramework-style LINQ query builder
RawQuery
Execute raw SQL queries with parameterization
RawSqlMigration
A migration that runs raw SQL statements
Repository<T>
SchemaManager
Manager for creating and managing database schemas
SelectBuilder
SQLiteConnection
SQLite implementation of DatabaseConnection
SQLiteTransaction
SQLite transaction implementation
StoredProcedure
Execute database stored procedures
StoredProcedureAnnotation
Stored procedure annotation for calling database stored procedures
StoredProcedureBuilder
Builder for creating stored procedures
Unique
Unique constraint annotation for single or multiple columns
UniqueConstraint
Unique constraint definition

Enums

ColumnType
Column types for database mapping
ConstraintAction
Actions for constraint operations (foreign key, etc.)
DatabaseType
Database types supported
ForeignKeyAction
Foreign key actions
JunctionColumnType
Column types for junction table extra columns
QueryType
Query types for the Query annotation
RelationAction
Actions for relationship constraints (used in annotations)
SQLType
SQL column types with their SQL string representation

Extensions

ColumnSchemaToSql on ColumnSchema
Extension to convert ColumnSchema to SQL
DatabaseSchemaToSql on DatabaseSchema
Extension to convert DatabaseSchema to SQL
ForeignKeyActionToSql on ForeignKeyAction
Extension to convert ForeignKeyAction to SQL
ForeignKeyToSql on ForeignKey
Extension to convert ForeignKey to SQL

Typedefs

MigrationCallback = Future<void> Function(DatabaseConnection connection, SchemaManager schemaManager)
Callback type for manual migrations