Schema reference

Use this page as a compact checklist. The detailed walkthroughs live in the dedicated pages for datasource/generator, models/fields, relations, enums, and native types.

Scalar types

Main scalar types recognized by comon_orm:

• Int
• String
• Boolean
• DateTime
• Float
• Decimal
• Json
• Bytes
• BigInt

See the full type mapping and attribute examples in Models and fields.

Datasource block

Typical keys:

• provider
• url

Examples:

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

datasource db {
  provider = "sqlite"
  url      = "dev.db"
}

See Datasource and generator for provider-specific setup guidance.

Generator block

Typical keys:

• provider
• output
• sqliteHelper

generator client {
  provider = "comon_orm"
  output   = "lib/generated/comon_orm_client.dart"
  sqliteHelper = "flutter"
}

sqliteHelper values:

• vm for comon_orm_sqlite
• flutter for comon_orm_sqlite_flutter

See Datasource and generator for full setup combinations.

Common field attributes

See Models and fields and Relations for full examples.

Model attributes

Provider-specific native types

PostgreSQL currently includes support for types such as @db.VarChar(n), @db.Text, @db.Json, @db.JsonB, @db.ByteA, @db.Numeric, @db.Timestamp, @db.Timestamptz, and @db.Uuid.

SQLite currently includes support for @db.Integer, @db.Numeric, @db.Real, @db.Text, and @db.Blob.

See Native types for the supported subset with example schemas.