Database.Persist.Migration.Operation.Types

Defines auxiliary data types that can be used in Operations.

Documentation

type ColumnIdentifier = (Text, Text)

A column identifier, table.column

dotted :: ColumnIdentifier -> Text

Make a ColumnIdentifier displayable.

data Column

The definition for a Column in a SQL database.

Constructors

Column

Fields

• colName :: Text
• colType :: SqlType
• colProps :: [ColumnProp]

Instances

Show Column

Defined in Database.Persist.Migration.Operation.Types

Methods

showsPrec :: Int -> Column -> ShowS

show :: Column -> String

showList :: [Column] -> ShowS

validateColumn :: Column -> Either String ()

Validate a Column.

data ColumnProp

A property for a Column.

Constructors

NotNull

Makes a column non-nullable (defaults to nullable)

References ColumnIdentifier

Mark this column as a foreign key to the given column

AutoIncrement

Makes a column auto-incrementing

Default PersistValue

Sets the default value for the column. Note that this doesn't matter when inserting data via Haskell; this property only sets the schema in the SQL backend.

See AddColumn for setting the default value for existing rows in a migration.

More info: https://www.yesodweb.com/book/persistent#persistent_attributes

Instances

Eq ColumnProp

Defined in Database.Persist.Migration.Operation.Types

Methods

(==) :: ColumnProp -> ColumnProp -> Bool

(/=) :: ColumnProp -> ColumnProp -> Bool

Show ColumnProp

Defined in Database.Persist.Migration.Operation.Types

Methods

showsPrec :: Int -> ColumnProp -> ShowS

show :: ColumnProp -> String

showList :: [ColumnProp] -> ShowS

data TableConstraint

Table constraints in a CREATE query.

Constructors

PrimaryKey [Text]

PRIMARY KEY (col1, col2, ...)

Unique Text [Text]

CONSTRAINT name UNIQUE (col1, col2, ...)

Instances

Show TableConstraint

Defined in Database.Persist.Migration.Operation.Types

Methods

showsPrec :: Int -> TableConstraint -> ShowS

show :: TableConstraint -> String

showList :: [TableConstraint] -> ShowS

isPrimaryKey :: TableConstraint -> Bool

getConstraintColumns :: TableConstraint -> [Text]

Get the columns defined in the given TableConstraint.