Database.Persist.Migration.Operation

Defines the Operation data types.

Documentation

data Operation

An operation that can be migrated.

Constructors

CreateTable

Fields

• name :: Text
• schema :: [Column]
• constraints :: [TableConstraint]

DropTable

Fields

• table :: Text

RenameTable

Fields

• from :: Text
• to :: Text

AddConstraint

Fields

• table :: Text
• constraint :: TableConstraint

DropConstraint

Fields

• table :: Text
• constraintName :: Text

AddColumn

Fields

• table :: Text
• column :: Column
• colDefault :: Maybe PersistValue

  The default for existing rows; required if the column is non-nullable

RenameColumn

Fields

• table :: Text
• from :: Text
• to :: Text

DropColumn

Fields

• columnId :: ColumnIdentifier

RawOperation

A custom operation that can be defined manually.

RawOperations should primarily use rawSql and rawExecute from the persistent library. If the operation depends on the backend being run, query connRDBMS from the SqlBackend:

asks connRDBMS >>= case
  "sqlite" -> ...
  _ -> return ()

Fields

• message :: Text
• rawOp :: SqlPersistT IO [MigrateSql]

Instances

Show Operation

Defined in Database.Persist.Migration.Operation

Methods

showsPrec :: Int -> Operation -> ShowS

show :: Operation -> String

showList :: [Operation] -> ShowS

validateOperation :: Operation -> Either String ()

Validate that the given Operation is valid.

Orphan instances

Show (SqlPersistT m a)

Methods

showsPrec :: Int -> SqlPersistT m a -> ShowS

show :: SqlPersistT m a -> String

showList :: [SqlPersistT m a] -> ShowS