Maintainer	Brandon Chinn <brandonchinn178@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Database.Persist.Migration.Operation

Contents

Orphan instances

Description

Defines the Operation data types.

Synopsis

type Version = Int
type OperationPath = (Version, Version)
(~>) :: Version -> Version -> OperationPath
type Migration = [MigrationPath]
data MigrationPath = OperationPath := [Operation]
opPath :: MigrationPath -> OperationPath
data Operation
- = CreateTable {
  - name :: Text
  - schema :: [Column]
  - constraints :: [TableConstraint]
  }
- | DropTable {
  - table :: Text
  }
- | RenameTable {
  - from :: Text
  - to :: Text
  }
- | AddConstraint {
  - table :: Text
  - constraint :: TableConstraint
  }
- | DropConstraint {
  - table :: Text
  - constraintName :: Text
  }
- | AddColumn {
  - table :: Text
  - column :: Column
  - colDefault :: Maybe PersistValue
  }
- | RenameColumn {
  - table :: Text
  - from :: Text
  - to :: Text
  }
- | DropColumn {
  - columnId :: ColumnIdentifier
  }
- | RawOperation {
  - message :: Text
  - rawOp :: SqlPersistT IO [MigrateSql]
  }
validateOperation :: Operation -> Either String ()

Documentation

type Version = Int Source #

The version of a database. An operation migrates from the given version to another version.

The version must be increasing, such that the lowest version is the first version and the highest version is the most up-to-date version.

A version represents a version of the database schema. In other words, any set of operations taken to get to version X *MUST* all result in the same database schema.

type OperationPath = (Version, Version) Source #

The path that an operation takes.

(~>) :: Version -> Version -> OperationPath Source #

An infix constructor for OperationPath.

type Migration = [MigrationPath] Source #

A migration list that defines operations to manually migrate a database schema.

data MigrationPath Source #

A path representing the operations needed to run to get from one version of the database schema to the next.

Constructors

OperationPath := [Operation]

Instances

Show MigrationPath Source #
Instance details Defined in Database.Persist.Migration.Operation Methods showsPrec :: Int -> MigrationPath -> ShowS # show :: MigrationPath -> String # showList :: [MigrationPath] -> ShowS #

opPath :: MigrationPath -> OperationPath Source #

Get the OperationPath in the MigrationPath.

data Operation Source #

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 Source #
Instance details Defined in Database.Persist.Migration.Operation Methods showsPrec :: Int -> Operation -> ShowS # show :: Operation -> String # showList :: [Operation] -> ShowS #

validateOperation :: Operation -> Either String () Source #

Validate that the given Operation is valid.

Orphan instances

Show (SqlPersistT m a) Source #
Instance details Methods showsPrec :: Int -> SqlPersistT m a -> ShowS # show :: SqlPersistT m a -> String # showList :: [SqlPersistT m a] -> ShowS #