@simplysm/orm-common 14.0.4 → 14.0.5

package/docs/types.md

@@ -2,35 +2,31 @@
 
 Core type definitions for the ORM.
 
-## Dialect
+## Database Types
 
-Supported database dialects.
+### Dialect
 
 ```typescript
 type Dialect = "mysql" | "mssql" | "postgresql";
 ```
 
-**Constant:**
+Supported database dialects. MySQL 8.0.14+, MSSQL 2012+, PostgreSQL 9.0+.
+
+### dialects
 
 ```typescript
 const dialects: Dialect[] = ["mysql", "mssql", "postgresql"];
 ```
 
-## IsolationLevel
+Array of all supported dialects. Useful for parameterized tests.
 
-Transaction isolation levels.
+### IsolationLevel
 
 ```typescript
-type IsolationLevel =
-  | "READ_UNCOMMITTED"
-  | "READ_COMMITTED"
-  | "REPEATABLE_READ"
-  | "SERIALIZABLE";
+type IsolationLevel = "READ_UNCOMMITTED" | "READ_COMMITTED" | "REPEATABLE_READ" | "SERIALIZABLE";
 ```
 
-## DataRecord
-
-Recursive data record type for query results. Supports nested relations.
+### DataRecord
 
 ```typescript
 type DataRecord = {
@@ -38,9 +34,9 @@ type DataRecord = {
 };
 ```
 
-## DbContextExecutor
+Recursive query result type. Supports nested relations via include/join.
 
-Interface for DB connection and query execution. Implemented by `NodeDbContextExecutor` (server) or service-based executors (client).
+### DbContextExecutor
 
 ```typescript
 interface DbContextExecutor {
@@ -56,9 +52,9 @@ interface DbContextExecutor {
 }
 ```
 
-## ResultMeta
+Query execution interface. Implemented by `NodeDbContextExecutor` (server) or service client executors.
 
-Metadata for transforming raw query results into typed TypeScript objects.
+### ResultMeta
 
 ```typescript
 interface ResultMeta {
@@ -67,14 +63,12 @@ interface ResultMeta {
 }
 ```
 
-| Field | Description |
-|---|---|
-| `columns` | Maps column name (dot-notation for nested) to TypeScript type name |
-| `joins` | Maps JOIN alias to single/array indicator |
-
-## Migration
+| Field | Type | Description |
+|-------|------|-------------|
+| `columns` | `Record<string, ColumnPrimitiveStr>` | Column name to type name mapping |
+| `joins` | `Record<string, { isSingle: boolean }>` | JOIN alias to single/array flag |
 
-Database migration definition for schema versioning.
+### Migration
 
 ```typescript
 interface Migration {
@@ -84,13 +78,11 @@ interface Migration {
 ```
 
 | Field | Type | Description |
-|---|---|---|
+|-------|------|-------------|
 | `name` | `string` | Unique migration name (timestamp recommended) |
-| `up` | `(db) => Promise<void>` | Migration function with DDL access |
-
-## QueryBuildResult
+| `up` | `(db) => Promise<void>` | Migration execution function |
 
-Return type of `QueryBuilderBase.build()`.
+### QueryBuildResult
 
 ```typescript
 interface QueryBuildResult {
@@ -101,29 +93,84 @@ interface QueryBuildResult {
 ```
 
 | Field | Type | Description |
-|---|---|---|
+|-------|------|-------------|
 | `sql` | `string` | Generated SQL string |
-| `resultSetIndex` | `number` | Result set index to read (default: 0) |
-| `resultSetStride` | `number` | Read every Nth result set (for multi-INSERT) |
+| `resultSetIndex` | `number?` | Index of result set to use |
+| `resultSetStride` | `number?` | Extract every Nth result set |
 
-## ColumnMeta
+## DbContext Types
 
-Column metadata generated by `ColumnBuilder`.
+### DbContextDef
 
 ```typescript
-interface ColumnMeta {
-  type: ColumnPrimitiveStr;
-  dataType: DataType;
-  autoIncrement?: boolean;
-  nullable?: boolean;
-  default?: ColumnPrimitive;
-  description?: string;
+interface DbContextDef<TTables, TViews, TProcedures> {
+  readonly meta: {
+    readonly tables: TTables;
+    readonly views: TViews;
+    readonly procedures: TProcedures;
+    readonly migrations: Migration[];
+  };
+}
+```
+
+DbContext blueprint created by `defineDbContext()`. Contains only schema metadata, no runtime state.
+
+### DbContextBase
+
+```typescript
+interface DbContextBase {
+  status: DbContextStatus;
+  readonly database: string | undefined;
+  readonly schema: string | undefined;
+  getNextAlias(): string;
+  resetAliasCounter(): void;
+  executeDefs<T = DataRecord>(defs: QueryDef[], resultMetas?: (ResultMeta | undefined)[]): Promise<T[][]>;
+  getQueryDefObjectName(tableOrView: TableBuilder | ViewBuilder): QueryDefObjectName;
+  switchFk(table: QueryDefObjectName, enabled: boolean): Promise<void>;
 }
 ```
 
-## DataType
+Core interface used internally by Queryable, Executable, and ViewBuilder.
+
+### DbContextStatus
+
+```typescript
+type DbContextStatus = "ready" | "connect" | "transact";
+```
+
+### DbContextInstance
+
+```typescript
+type DbContextInstance<TDef extends DbContextDef<any, any, any>> =
+  DbContextBase &
+  DbContextConnectionMethods &
+  DbContextDdlMethods &
+  { [K in keyof TDef["meta"]["tables"]]: () => Queryable<...> } &
+  { [K in keyof TDef["meta"]["views"]]: () => Queryable<...> } &
+  { [K in keyof TDef["meta"]["procedures"]]: () => Executable<...> } &
+  { _migration: () => Queryable<{ code: string }, any> } &
+  { initialize(options?: { dbs?: string[]; force?: boolean }): Promise<void> };
+```
+
+Full DbContext instance type returned by `createDbContext()`. Includes queryable accessors for all tables/views, executable accessors for all procedures, connection methods, DDL methods, and `initialize()`.
+
+### DbContextConnectionMethods
+
+```typescript
+interface DbContextConnectionMethods {
+  connect<TResult>(fn: () => Promise<TResult>, isolationLevel?: IsolationLevel): Promise<TResult>;
+  connectWithoutTransaction<TResult>(callback: () => Promise<TResult>): Promise<TResult>;
+  transaction<TResult>(fn: () => Promise<TResult>, isolationLevel?: IsolationLevel): Promise<TResult>;
+}
+```
+
+### DbContextDdlMethods
+
+See [Core - DDL Execution Methods](./core.md#ddl-execution-methods) and [Core - DDL QueryDef Generators](./core.md#ddl-querydef-generators) for the full list of 18 DDL execution methods and 22 QueryDef generator methods.
+
+## Column Types
 
-SQL data type definition. Discriminated union on `type` field.
+### DataType
 
 ```typescript
 type DataType =
@@ -143,30 +190,23 @@ type DataType =
   | { type: "uuid" };
 ```
 
-**DBMS Mapping:**
+SQL data type definition. Used in ColumnBuilder metadata, CAST expressions, and DDL generation.
 
-| DataType | MySQL | MSSQL | PostgreSQL |
-|---|---|---|---|
-| `int` | INT | INT | INT |
-| `bigint` | BIGINT | BIGINT | BIGINT |
-| `float` | FLOAT | REAL | REAL |
-| `double` | DOUBLE | FLOAT | DOUBLE PRECISION |
-| `decimal` | DECIMAL(p,s) | DECIMAL(p,s) | DECIMAL(p,s) |
-| `varchar` | VARCHAR(n) | NVARCHAR(n) | VARCHAR(n) |
-| `char` | CHAR(n) | NCHAR(n) | CHAR(n) |
-| `text` | LONGTEXT | NVARCHAR(MAX) | TEXT |
-| `binary` | LONGBLOB | VARBINARY(MAX) | BYTEA |
-| `boolean` | TINYINT(1) | BIT | BOOLEAN |
-| `datetime` | DATETIME | DATETIME2 | TIMESTAMP |
-| `date` | DATE | DATE | DATE |
-| `time` | TIME | TIME | TIME |
-| `uuid` | BINARY(16) | UNIQUEIDENTIFIER | UUID |
+### ColumnPrimitive
 
-## Column Primitive Types
+```typescript
+type ColumnPrimitive = string | number | boolean | DateTime | DateOnly | Time | Uuid | Bytes | undefined;
+```
 
-### ColumnPrimitiveMap
+All storable column primitive types. `undefined` represents SQL NULL.
 
-Maps TypeScript type names to actual types.
+### ColumnPrimitiveStr
+
+```typescript
+type ColumnPrimitiveStr = "string" | "number" | "boolean" | "DateTime" | "DateOnly" | "Time" | "Uuid" | "Bytes";
+```
+
+### ColumnPrimitiveMap
 
 ```typescript
 type ColumnPrimitiveMap = {
@@ -181,224 +221,143 @@ type ColumnPrimitiveMap = {
 };
 ```
 
-### ColumnPrimitiveStr
+### ColumnMeta
 
 ```typescript
-type ColumnPrimitiveStr = keyof ColumnPrimitiveMap;
-// "string" | "number" | "boolean" | "DateTime" | "DateOnly" | "Time" | "Uuid" | "Bytes"
+interface ColumnMeta {
+  type: ColumnPrimitiveStr;
+  dataType: DataType;
+  autoIncrement?: boolean;
+  nullable?: boolean;
+  default?: ColumnPrimitive;
+  description?: string;
+}
 ```
 
-### ColumnPrimitive
-
-All primitive types that can be stored in columns. `undefined` represents NULL.
+### dataTypeStrToColumnPrimitiveStr
 
 ```typescript
-type ColumnPrimitive = ColumnPrimitiveMap[ColumnPrimitiveStr] | undefined;
+const dataTypeStrToColumnPrimitiveStr: Record<DataType["type"], ColumnPrimitiveStr>
 ```
 
-### dataTypeStrToColumnPrimitiveStr
+Maps SQL type names to TypeScript type names. For example: `"int"` -> `"number"`, `"datetime"` -> `"DateTime"`, `"varchar"` -> `"string"`.
 
-Constant mapping SQL DataType string to ColumnPrimitiveStr.
+### InferColumnPrimitiveFromDataType
 
 ```typescript
-const dataTypeStrToColumnPrimitiveStr: Record<DataType["type"], ColumnPrimitiveStr>;
-// { int: "number", bigint: "number", varchar: "string", datetime: "DateTime", ... }
+type InferColumnPrimitiveFromDataType<TDataType extends DataType> = ColumnPrimitiveMap[...]
 ```
 
-### InferColumnPrimitiveFromDataType
+Infers the TypeScript type from a DataType definition.
 
-Infer TypeScript type from a `DataType`.
+### inferColumnPrimitiveStr
 
 ```typescript
-type InferColumnPrimitiveFromDataType<T extends DataType> = ColumnPrimitiveMap[...];
+function inferColumnPrimitiveStr(value: ColumnPrimitive): ColumnPrimitiveStr
 ```
 
-### inferColumnPrimitiveStr
+Infers the ColumnPrimitiveStr from a runtime value. Throws for unknown types.
+
+## Column Builder Types
 
-Infer `ColumnPrimitiveStr` from a runtime value.
+### ColumnBuilderRecord
 
 ```typescript
-function inferColumnPrimitiveStr(value: ColumnPrimitive): ColumnPrimitiveStr;
+type ColumnBuilderRecord = Record<string, ColumnBuilder<ColumnPrimitive, ColumnMeta>>;
 ```
 
-## QueryDef Types
+### InferColumns
+
+```typescript
+type InferColumns<TBuilders extends ColumnBuilderRecord> = {
+  [K in keyof TBuilders]: TBuilders[K] extends ColumnBuilder<infer V, any> ? V : never;
+};
+```
 
-All query definition types used by the QueryBuilder.
+Extracts runtime value types from a column builder record.
 
-### QueryDefObjectName
+### InferColumnExprs
 
 ```typescript
-interface QueryDefObjectName {
-  database?: string;
-  schema?: string;
-  name: string;
-}
+type InferColumnExprs<TBuilders extends ColumnBuilderRecord> = {
+  [K in keyof TBuilders]: TBuilders[K] extends ColumnBuilder<infer V, any> ? ExprInput<V> : never;
+};
 ```
 
-### CudOutputDef
+### InferInsertColumns
 
 ```typescript
-interface CudOutputDef {
-  columns: string[];
-  pkColNames: string[];
-  aiColName?: string;
-}
+type InferInsertColumns<TBuilders> = Pick<InferColumns<TBuilders>, RequiredInsertKeys<TBuilders>> &
+  Partial<Pick<InferColumns<TBuilders>, OptionalInsertKeys<TBuilders>>>;
 ```
 
-### SelectQueryDef
+INSERT type: required columns are required, autoIncrement/nullable/default columns are optional.
+
+### InferUpdateColumns
 
 ```typescript
-interface SelectQueryDef {
-  type: "select";
-  from?: QueryDefObjectName | SelectQueryDef | SelectQueryDef[] | string;
-  as: string;
-  select?: Record<string, Expr>;
-  distinct?: boolean;
-  top?: number;
-  lock?: boolean;
-  where?: WhereExpr[];
-  joins?: SelectQueryDefJoin[];
-  orderBy?: [Expr, ("ASC" | "DESC")?][];
-  limit?: [number, number];
-  groupBy?: Expr[];
-  having?: WhereExpr[];
-  with?: { name: string; base: SelectQueryDef; recursive: SelectQueryDef };
-}
+type InferUpdateColumns<TBuilders> = Partial<InferColumns<TBuilders>>;
 ```
 
-### SelectQueryDefJoin
+UPDATE type: all columns are optional.
+
+### RequiredInsertKeys
 
 ```typescript
-interface SelectQueryDefJoin extends SelectQueryDef {
-  isSingle?: boolean;
-}
+type RequiredInsertKeys<TBuilders> = /* columns without autoIncrement, nullable, or default */
 ```
 
-### InsertQueryDef
+### OptionalInsertKeys
 
 ```typescript
-interface InsertQueryDef {
-  type: "insert";
-  table: QueryDefObjectName;
-  records: Record<string, ColumnPrimitive>[];
-  overrideIdentity?: boolean;
-  output?: CudOutputDef;
-}
+type OptionalInsertKeys<TBuilders> = Exclude<keyof TBuilders, RequiredInsertKeys<TBuilders>>;
 ```
 
-### InsertIfNotExistsQueryDef
+### DataToColumnBuilderRecord
 
 ```typescript
-interface InsertIfNotExistsQueryDef {
-  type: "insertIfNotExists";
-  table: QueryDefObjectName;
-  record: Record<string, ColumnPrimitive>;
-  existsSelectQuery: Omit<SelectQueryDef, "select">;
-  output?: CudOutputDef;
-}
+type DataToColumnBuilderRecord<TData extends DataRecord> = {
+  [K in keyof TData as TData[K] extends ColumnPrimitive ? K : never]: ColumnBuilder<TData[K], any>;
+};
 ```
 
-### InsertIntoQueryDef
+## Relation Types
+
+### RelationBuilderRecord
 
 ```typescript
-interface InsertIntoQueryDef {
-  type: "insertInto";
-  table: QueryDefObjectName;
-  recordsSelectQuery: SelectQueryDef;
-  output?: CudOutputDef;
-}
+type RelationBuilderRecord = Record<string,
+  ForeignKeyBuilder<any, any> | ForeignKeyTargetBuilder<any, any> |
+  RelationKeyBuilder<any, any> | RelationKeyTargetBuilder<any, any>>;
 ```
 
-### UpdateQueryDef
+### InferDeepRelations
 
 ```typescript
-interface UpdateQueryDef {
-  type: "update";
-  table: QueryDefObjectName;
-  as: string;
-  record: Record<string, Expr>;
-  top?: number;
-  where?: WhereExpr[];
-  joins?: SelectQueryDefJoin[];
-  limit?: [number, number];
-  output?: CudOutputDef;
-}
+type InferDeepRelations<TRelations extends RelationBuilderRecord> = {
+  [K in keyof TRelations]?: ExtractRelationTarget<TRelations[K]> | ExtractRelationTargetResult<TRelations[K]>;
+};
 ```
 
-### DeleteQueryDef
+All relations are optional (loaded only via `include()`).
+
+### ExtractRelationTarget
 
 ```typescript
-interface DeleteQueryDef {
-  type: "delete";
-  table: QueryDefObjectName;
-  as: string;
-  top?: number;
-  where?: WhereExpr[];
-  joins?: SelectQueryDefJoin[];
-  limit?: [number, number];
-  output?: CudOutputDef;
-}
+type ExtractRelationTarget<TRelation> = /* Extracts N:1 target type (single object) */
 ```
 
-### UpsertQueryDef
+For FK/RelationKey relations, extracts `InferColumns<TCols> & InferDeepRelations<TRels>` of the target table.
+
+### ExtractRelationTargetResult
 
 ```typescript
-interface UpsertQueryDef {
-  type: "upsert";
-  table: QueryDefObjectName;
-  existsSelectQuery: Omit<SelectQueryDef, "select">;
-  updateRecord: Record<string, Expr>;
-  insertRecord: Record<string, Expr>;
-  output?: CudOutputDef;
-}
+type ExtractRelationTargetResult<TRelation> = /* Extracts 1:N target type (array or single) */
 ```
 
-### DDL QueryDef Types
-
-| Type | Description |
-|---|---|
-| `CreateTableQueryDef` | CREATE TABLE |
-| `DropTableQueryDef` | DROP TABLE |
-| `RenameTableQueryDef` | RENAME TABLE |
-| `TruncateQueryDef` | TRUNCATE TABLE |
-| `AddColumnQueryDef` | ADD COLUMN |
-| `DropColumnQueryDef` | DROP COLUMN |
-| `ModifyColumnQueryDef` | ALTER COLUMN |
-| `RenameColumnQueryDef` | RENAME COLUMN |
-| `AddPrimaryKeyQueryDef` | ADD PRIMARY KEY |
-| `DropPrimaryKeyQueryDef` | DROP PRIMARY KEY |
-| `AddForeignKeyQueryDef` | ADD FOREIGN KEY |
-| `DropForeignKeyQueryDef` | DROP FOREIGN KEY |
-| `AddIndexQueryDef` | CREATE INDEX |
-| `DropIndexQueryDef` | DROP INDEX |
-| `CreateViewQueryDef` | CREATE VIEW |
-| `DropViewQueryDef` | DROP VIEW |
-| `CreateProcQueryDef` | CREATE PROCEDURE |
-| `DropProcQueryDef` | DROP PROCEDURE |
-| `ExecProcQueryDef` | EXECUTE PROCEDURE |
-| `ClearSchemaQueryDef` | Clear all objects in schema |
-| `SchemaExistsQueryDef` | Check schema existence |
-| `SwitchFkQueryDef` | Enable/disable FK constraints |
-
-### QueryDef (union)
-
-```typescript
-type QueryDef = SelectQueryDef | InsertQueryDef | InsertIfNotExistsQueryDef
-  | InsertIntoQueryDef | UpdateQueryDef | DeleteQueryDef | UpsertQueryDef
-  | CreateTableQueryDef | DropTableQueryDef | RenameTableQueryDef
-  | TruncateQueryDef | AddColumnQueryDef | DropColumnQueryDef
-  | ModifyColumnQueryDef | RenameColumnQueryDef
-  | AddPrimaryKeyQueryDef | DropPrimaryKeyQueryDef
-  | AddForeignKeyQueryDef | DropForeignKeyQueryDef
-  | AddIndexQueryDef | DropIndexQueryDef
-  | CreateViewQueryDef | DropViewQueryDef
-  | CreateProcQueryDef | DropProcQueryDef | ExecProcQueryDef
-  | ClearSchemaQueryDef | SchemaExistsQueryDef | SwitchFkQueryDef;
-```
-
-## Expr Types
-
-All expression AST node types. See [expression.md](expression.md) for the `expr` builder API.
+For FKTarget/RelationKeyTarget relations, extracts an array type (or single object if `isSingle: true`).
+
+## Expression Types
 
 ### DateUnit
 
@@ -408,18 +367,17 @@ type DateUnit = "year" | "month" | "day" | "hour" | "minute" | "second";
 
 ### WhereExpr
 
-Union of all WHERE-clause expression types.
-
 ```typescript
 type WhereExpr =
   | ExprEq | ExprGt | ExprLt | ExprGte | ExprLte | ExprBetween
-  | ExprIsNull | ExprLike | ExprRegexp | ExprIn | ExprInQuery | ExprExists
+  | ExprIsNull | ExprLike | ExprRegexp
+  | ExprIn | ExprInQuery | ExprExists
   | ExprNot | ExprAnd | ExprOr;
 ```
 
-### Expr
+Union of all WHERE-clause expression types (comparison + logical).
 
-Union of all expression types (values, functions, aggregates, window, etc.).
+### Expr
 
 ```typescript
 type Expr =
@@ -436,6 +394,17 @@ type Expr =
   | ExprWindow | ExprSubquery;
 ```
 
+Union of all expression types (value, string, number, date, conditional, aggregate, window, system).
+
+### WinFn
+
+```typescript
+type WinFn =
+  | WinFnRowNumber | WinFnRank | WinFnDenseRank | WinFnNtile
+  | WinFnLag | WinFnLead | WinFnFirstValue | WinFnLastValue
+  | WinFnSum | WinFnAvg | WinFnCount | WinFnMin | WinFnMax;
+```
+
 ### WinSpec
 
 ```typescript
@@ -445,57 +414,107 @@ interface WinSpec {
 }
 ```
 
-### WinFn
+## QueryDef Types
 
-Union of all window function types.
+### QueryDefObjectName
 
 ```typescript
-type WinFn =
-  | WinFnRowNumber | WinFnRank | WinFnDenseRank | WinFnNtile
-  | WinFnLag | WinFnLead | WinFnFirstValue | WinFnLastValue
-  | WinFnSum | WinFnAvg | WinFnCount | WinFnMin | WinFnMax;
+interface QueryDefObjectName {
+  database?: string;
+  schema?: string;
+  name: string;
+}
 ```
 
-## parseQueryResult
+DB object name. MySQL: `database.name`, MSSQL: `database.schema.name`, PostgreSQL: `schema.name`.
 
-Transforms raw DB query results into typed TypeScript objects using `ResultMeta`. Handles type parsing, flat-to-nested conversion, and JOIN grouping.
+### QueryDef
 
 ```typescript
-async function parseQueryResult<TRecord>(
-  rawResults: Record<string, unknown>[],
-  meta: ResultMeta,
-): Promise<TRecord[] | undefined>;
+type QueryDef =
+  // DML
+  | SelectQueryDef | InsertQueryDef | InsertIfNotExistsQueryDef | InsertIntoQueryDef
+  | UpdateQueryDef | DeleteQueryDef | UpsertQueryDef
+  // DDL
+  | ClearSchemaQueryDef | CreateTableQueryDef | DropTableQueryDef | RenameTableQueryDef
+  | TruncateQueryDef | AddColumnQueryDef | DropColumnQueryDef | ModifyColumnQueryDef
+  | RenameColumnQueryDef | DropPrimaryKeyQueryDef | AddPrimaryKeyQueryDef
+  | AddForeignKeyQueryDef | DropForeignKeyQueryDef | AddIndexQueryDef | DropIndexQueryDef
+  | CreateViewQueryDef | DropViewQueryDef | CreateProcQueryDef | DropProcQueryDef
+  // Utils/Meta
+  | ExecProcQueryDef | SwitchFkQueryDef | SchemaExistsQueryDef;
 ```
 
-**Parameters:**
+### DDL_TYPES
 
-| Parameter | Type | Description |
-|---|---|---|
-| `rawResults` | `Record<string, unknown>[]` | Raw result rows from database |
-| `meta` | `ResultMeta` | Type and JOIN structure metadata |
+```typescript
+const DDL_TYPES: readonly DdlType[]
+```
 
-**Returns:** Typed and nested result array, or `undefined` if empty.
+Array of all DDL query type strings. Used for blocking DDL inside transactions.
 
-**Example:**
+### DdlType
 
 ```typescript
-const raw = [
-  { id: "1", name: "User1", "posts.id": "10", "posts.title": "Post1" },
-  { id: "1", name: "User1", "posts.id": "11", "posts.title": "Post2" },
-];
-const meta = {
-  columns: { id: "number", name: "string", "posts.id": "number", "posts.title": "string" },
-  joins: { posts: { isSingle: false } },
-};
-const result = await parseQueryResult(raw, meta);
-// [{ id: 1, name: "User1", posts: [{ id: 10, title: "Post1" }, { id: 11, title: "Post2" }] }]
+type DdlType = "clearSchema" | "createTable" | "dropTable" | "renameTable" | "truncate"
+  | "addColumn" | "dropColumn" | "modifyColumn" | "renameColumn"
+  | "dropPrimaryKey" | "addPrimaryKey" | "addForeignKey" | "dropForeignKey"
+  | "addIndex" | "dropIndex" | "createView" | "dropView" | "createProc" | "dropProc";
 ```
 
-## _Migration
+### DML QueryDef Interfaces
+
+| Interface | type field | Key fields |
+|-----------|-----------|-------------|
+| `SelectQueryDef` | `"select"` | `from`, `as`, `select`, `distinct`, `top`, `lock`, `where`, `joins`, `orderBy`, `limit`, `groupBy`, `having`, `with` |
+| `SelectQueryDefJoin` | `"select"` | Extends SelectQueryDef + `isSingle` |
+| `InsertQueryDef` | `"insert"` | `table`, `records`, `overrideIdentity`, `output` |
+| `InsertIfNotExistsQueryDef` | `"insertIfNotExists"` | `table`, `record`, `existsSelectQuery`, `output` |
+| `InsertIntoQueryDef` | `"insertInto"` | `table`, `recordsSelectQuery`, `output` |
+| `UpdateQueryDef` | `"update"` | `table`, `as`, `record`, `top`, `where`, `joins`, `limit`, `output` |
+| `DeleteQueryDef` | `"delete"` | `table`, `as`, `top`, `where`, `joins`, `limit`, `output` |
+| `UpsertQueryDef` | `"upsert"` | `table`, `existsSelectQuery`, `insertRecord`, `updateRecord`, `output` |
+| `ExecProcQueryDef` | `"execProc"` | `procedure`, `params` |
+
+### DDL QueryDef Interfaces
+
+| Interface | type field | Key fields |
+|-----------|-----------|-------------|
+| `ClearSchemaQueryDef` | `"clearSchema"` | `database`, `schema` |
+| `CreateTableQueryDef` | `"createTable"` | `table`, `columns`, `primaryKey` |
+| `DropTableQueryDef` | `"dropTable"` | `table` |
+| `RenameTableQueryDef` | `"renameTable"` | `table`, `newName` |
+| `TruncateQueryDef` | `"truncate"` | `table` |
+| `AddColumnQueryDef` | `"addColumn"` | `table`, `column` |
+| `DropColumnQueryDef` | `"dropColumn"` | `table`, `column` |
+| `ModifyColumnQueryDef` | `"modifyColumn"` | `table`, `column` |
+| `RenameColumnQueryDef` | `"renameColumn"` | `table`, `column`, `newName` |
+| `AddPrimaryKeyQueryDef` | `"addPrimaryKey"` | `table`, `columns` |
+| `DropPrimaryKeyQueryDef` | `"dropPrimaryKey"` | `table` |
+| `AddForeignKeyQueryDef` | `"addForeignKey"` | `table`, `foreignKey` |
+| `DropForeignKeyQueryDef` | `"dropForeignKey"` | `table`, `foreignKey` |
+| `AddIndexQueryDef` | `"addIndex"` | `table`, `index` |
+| `DropIndexQueryDef` | `"dropIndex"` | `table`, `index` |
+| `CreateViewQueryDef` | `"createView"` | `view`, `queryDef` |
+| `DropViewQueryDef` | `"dropView"` | `view` |
+| `CreateProcQueryDef` | `"createProc"` | `procedure`, `params`, `returns`, `query` |
+| `DropProcQueryDef` | `"dropProc"` | `procedure` |
+
+### Utility QueryDef Interfaces
 
-System migration table definition. Automatically added to every `DbContextDef` by `defineDbContext()`.
+| Interface | type field | Key fields |
+|-----------|-----------|-------------|
+| `SwitchFkQueryDef` | `"switchFk"` | `table`, `enabled` |
+| `SchemaExistsQueryDef` | `"schemaExists"` | `database`, `schema` |
+
+### CudOutputDef
 
 ```typescript
-const _Migration: TableBuilder<{ code: ColumnBuilder<string, ...> }, {}>;
-// Table: "_migration", columns: { code: varchar(255) }, primaryKey: "code"
+interface CudOutputDef {
+  columns: string[];
+  pkColNames: string[];
+  aiColName?: string;
+}
 ```
+
+OUTPUT clause definition for INSERT/UPDATE/DELETE.