Types

All types are exported from @smplcty/schema-flow.

Schema types

import type {
  TableSchema,
  ColumnDef,
  IndexDef,
  CheckDef,
  UniqueConstraintDef,
  TriggerDef,
  PolicyDef,
  MixinSchema,
  FunctionSchema,
  FunctionArg,
  EnumSchema,
  ExtensionsSchema,
  ViewSchema,
  MaterializedViewSchema,
  RoleSchema,
  GrantDef,
  FunctionGrantDef,
  PrecheckDef,
  SeedRow,
  ExpandDef,
  ForeignKeyRef,
  SchemaGrant,
} from '@smplcty/schema-flow';

Enum types

import type {
  ForeignKeyAction, // 'CASCADE' | 'SET NULL' | 'SET DEFAULT' | 'RESTRICT' | 'NO ACTION'
  IndexMethod, // 'btree' | 'gin' | 'gist' | 'hash' | 'brin'
  FunctionSecurity, // 'invoker' | 'definer'
  FunctionVolatility, // 'volatile' | 'stable' | 'immutable'
  FunctionParallel, // 'unsafe' | 'safe' | 'restricted'
  FunctionArgMode, // 'IN' | 'OUT' | 'INOUT' | 'VARIADIC'
  TriggerTiming, // 'BEFORE' | 'AFTER' | 'INSTEAD OF'
  TriggerEvent, // 'INSERT' | 'UPDATE' | 'DELETE' | 'TRUNCATE'
  TriggerForEach, // 'ROW' | 'STATEMENT'
  PolicyCommand, // 'SELECT' | 'INSERT' | 'UPDATE' | 'DELETE' | 'ALL'
} from '@smplcty/schema-flow';

Planner types

import type {
  Operation,
  OperationType,
  PlanResult,
  PlanOptions,
  DesiredState,
  ActualState,
} from '@smplcty/schema-flow';

Drift types

import type { DriftReport, DriftItem, DriftItemType, DriftStatus } from '@smplcty/schema-flow';

Lint types

import type { LintResult, LintWarning, LintSeverity } from '@smplcty/schema-flow';

Executor types

import type { ExecuteOptions, ExecuteResult, InvalidIndex } from '@smplcty/schema-flow';

Rollback types

import type { MigrationSnapshot, RollbackResult, RunDownOptions, RunDownResult } from '@smplcty/schema-flow';

Expand types

import type {
  ExpandState,
  ExpandOperationType,
  ExpandOperation,
  BackfillOptions,
  BackfillResult,
  ContractOptions,
  ContractResult,
} from '@smplcty/schema-flow';

Generation types

import type { GenerateInput, GeneratedFile, GenerateSqlOptions } from '@smplcty/schema-flow';

Config types

import type { SimplicitySchemaConfig, ConfigOverrides } from '@smplcty/schema-flow';

Logger types

import type { Logger, LoggerOptions } from '@smplcty/schema-flow';

import { LogLevel } from '@smplcty/schema-flow';

File types

import type { Phase, SchemaFile, DiscoveredFiles, SchemaKind, ParsedSchema } from '@smplcty/schema-flow';

Pipeline types

import type { PipelineOptions, StatusResult, BaselineResult } from '@smplcty/schema-flow';

Database types

import type { ClientOptions } from '@smplcty/schema-flow';

Mixin types

import type { MixinRegistry } from '@smplcty/schema-flow';