API reference

Most symbols come from one import:

import 'package:gisila_orm/gisila.dart';

A few live in separate libraries, noted below: package:gisila_orm/web.dart (gisila integration), package:gisila_orm/generators/schema_parser.dart (schema model and diagnostics) and package:gisila_orm/generators/project_codegen.dart (generator internals).

Pages

Page	Covers
Schema YAML format	Every key, column type, default rule, index and check option, and the diagnostic codes.
Generated code	Model classes, <Model>Table, generated relations and accessors, enums, TableMeta, Hydrator, RowMapper.
Query builder	Query<T> clauses and terminal operations, CompiledSql, OrderTerm, SortOrder, JoinSpec, JoinType.
Expressions and operators	Expr, ColumnRef and its operator extensions, RawSql, SqlCompiler, AST node classes.
Insert, update, delete and upsert	InsertQuery, UpdateQuery, DeleteQuery, ON CONFLICT.
Relations and preloading	Relation and its four kinds, Query.preload, Preloader, Preloadable.
Database, contexts and transactions	Database, DbContext, PoolDbContext, TxDbContext, ConnectionDbContext, QueryObserver, slowQueryLogger.
Database configuration	DatabaseConfig, DatabaseConnection, DatabaseSslMode, database.yaml, environment variables.
Migrations API	MigrationManager, Migration, SchemaDiffer, SchemaDiff, SchemaDefinition.
CLI commands	gisila_orm:generate, gisila_orm:migrate up/down/status/diff.
build.yaml and build_runner	The schemaBuilder builder.
Value types and helpers	Vector, VectorDistance, VectorIndexMethod, Point, Box, Circle, Lseg, encodeJsonColumn, SafeString.
Errors	PostgresException hierarchy, PostgresErrorMapper, builder, config, migration and schema exceptions.
gisila integration	GisilaOrmDatabaseProvider, PostgresDbErrorMapper.

Symbols by area

Querying

Symbol	Kind	Page
Query<T>	class	Query builder
CompiledSql	class	Query builder
OrderTerm, SortOrder, JoinSpec, JoinType	class / enum	Query builder
InsertQuery<T>	class	Mutations
UpdateQuery<T>	class	Mutations
DeleteQuery<T>	class	Mutations
TableMeta<T>	class	Generated code
Hydrator<T>, RowMapper<T>	class / typedef	Generated code

Expressions

Symbol	Kind	Page
Expr<T>	abstract class	Expressions
ColumnRef<T>	class	Expressions
StringColumnRefOps, NullableStringColumnRefOps	extension	Expressions
JsonColumnRefOps	extension	Expressions
ArrayColumnRefOps	extension	Expressions
VectorColumnRefOps, NullableVectorColumnRefOps	extension	Expressions
RawSql<T>	class	Expressions
SqlCompiler	class	Expressions
Literal, BinOp, UnaryOp, FuncCall, InList, Between, NullCheck, VectorLiteral, ExprVisitor	class	Expressions

Relations

Symbol	Kind	Page
Relation<Parent, Child>, RelationKind	abstract class / enum	Relations
HasManyRelation, HasOneRelation, BelongsToRelation, ManyToManyRelation	class	Relations
Preloader	class	Relations
Preloadable	mixin	Relations

Runtime and connections

Symbol	Kind	Page
Database	class	Database
DbContext	abstract class	Database
PoolDbContext, TxDbContext, ConnectionDbContext	class	Database
QueryObserver, slowQueryLogger	typedef / function	Database
cursorBatchSize, runTransaction	const / function	Database
Endpoint, SslMode	re-exported from package:postgres	Database
DatabaseConfig, DatabaseConnection	class	Configuration
DatabaseType, DatabaseSslMode	enum	Configuration

Migrations

Symbol	Kind	Page
MigrationManager	class	Migrations
Migration, AppliedMigration, MigrationResult	class	Migrations
MigrationChecksumException	exception	Migrations
migrationChecksum, splitSqlStatements	function	Migrations
SchemaDiffer, SchemaDiff, SchemaChange, ChangeType, MigrationOperation	class / enum	Migrations
DestructiveMigrationException	exception	Migrations
SchemaDefinition, emitSchemaYaml (schema_parser.dart)	class / function	Migrations
generateProjectSchema, generateProjectIncrementalMigration, discoverSchemaFiles (project_codegen.dart)	function	CLI
schemaBuilder, SchemaBuilder (schema_builder.dart)	builder	build.yaml

Types and helpers

Symbol	Kind	Page
Vector, VectorDistance, VectorIndexMethod	class / enum	Types
Point, Box, Circle, Lseg	class	Types
encodeJsonColumn	function	Types
SafeString (safeTk, safe)	extension	Types

Errors

Symbol	Kind	Page
PostgresException and subclasses	exception	Errors
PostgresErrorMapper	class	Errors
QueryNoRowsException, QueryMultipleRowsException, InsertReturnedNoRowsException, InvalidQueryBuilderException, PreloadException	exception	Errors
DatabaseConfigurationException	exception	Errors
MigrationRollbackException	exception	Errors
SchemaValidationException, SchemaError, SchemaErrorLevel (schema_parser.dart)	exception / class / enum	Errors
DefaultValueException, QueryException, ValidationException	exception	Errors

gisila integration (web.dart)

Symbol	Kind	Page
GisilaOrmDatabaseProvider	class	gisila integration
PostgresDbErrorMapper	class	gisila integration