Class ConstraintBuilder<Schema, Ext>
Methods
check
- check<Table>(query, opts?): ast.ConstraintDefinition<ast.CheckConstraint<Ext>, Ext>
Parameters
opts: {
deferrable?: boolean;
initiallyDeferred?: boolean;
name?: string;
} = {}
Optional deferrable?: boolean
Optional initiallyDeferred?: boolean
Optional name?: string
notNull
- notNull(opts?): ast.ConstraintDefinition<ast.ColumnNotNull, Ext>
Parameters
opts: {
deferrable?: boolean;
initiallyDeferred?: boolean;
name?: string;
} = {}
Optional deferrable?: boolean
Optional initiallyDeferred?: boolean
Optional name?: string
references
- references(opts): ast.ConstraintDefinition<ast.ReferenceConstraint<Ext>, Ext>
Parameters
opts: {
columns: string[];
deferrable?: boolean;
initiallyDeferred?: boolean;
match?: "full" | "FULL" | "PARTIAL" | "partial";
name?: string;
onDelete?: ReferentialActionArg;
onUpdate?: ReferentialActionArg;
table: string;
}
columns: string[]
Optional deferrable?: boolean
Optional initiallyDeferred?: boolean
Optional match?: "full" | "FULL" | "PARTIAL" | "partial"
Optional name?: string
Optional onDelete?: ReferentialActionArg
Optional onUpdate?: ReferentialActionArg
table: string
unique
- unique(opts?): ast.ConstraintDefinition<ast.UniqueConstraint<Ext>, Ext>
Parameters
opts: {
columns?: string[];
deferrable?: boolean;
initiallyDeferred?: boolean;
name?: string;
primaryKey?: boolean;
} = {}
Optional columns?: string[]
Optional deferrable?: boolean
Optional initiallyDeferred?: boolean
Optional name?: string
Optional primaryKey?: boolean