Safe Haskell	None
Language	Haskell2010

Database.Selda.Validation

Description

Utilities for validating and inspecting Selda tables.

Synopsis

data TableDiff
- = TableOK
- | TableMissing
- | UniqueMissing [[ColName]]
- | UniquePresent [[ColName]]
- | PkMissing [ColName]
- | PkPresent [ColName]
- | InconsistentColumns [(ColName, [ColumnDiff])]
data ColumnDiff
- = ColumnMissing
- | ColumnPresent
- | NameMismatch ColName
- | UnknownType Text
- | TypeMismatch SqlTypeRep SqlTypeRep
- | AutoIncrementMismatch Bool
- | NullableMismatch Bool
- | ForeignKeyMissing TableName ColName
- | ForeignKeyPresent TableName ColName
- | IndexMismatch Bool
data TableName
data ColName
data ColumnInfo
data SqlTypeRep
tableInfo :: Table a -> TableInfo
showTableDiff :: TableDiff -> Text
showColumnDiff :: ColumnDiff -> Text
describeTable :: MonadSelda m => TableName -> m TableInfo
diffTable :: MonadSelda m => Table a -> m TableDiff
diffTables :: Table a -> Table b -> TableDiff
validateTable :: (MonadSelda m, MonadThrow m) => Table a -> m ()
validateSchema :: MonadThrow m => Table a -> m ()

Documentation

data TableDiff Source #

A description of the difference between a schema and its corresponding database table.

Constructors

TableOK
TableMissing
UniqueMissing [[ColName]]
UniquePresent [[ColName]]
PkMissing [ColName]
PkPresent [ColName]
InconsistentColumns [(ColName, [ColumnDiff])]

Instances

Eq TableDiff Source #
Instance details Defined in Database.Selda.Validation Methods (==) :: TableDiff -> TableDiff -> Bool # (/=) :: TableDiff -> TableDiff -> Bool #
Show TableDiff Source #
Instance details Defined in Database.Selda.Validation Methods showsPrec :: Int -> TableDiff -> ShowS # show :: TableDiff -> String # showList :: [TableDiff] -> ShowS #

data ColumnDiff Source #

A description of the difference between a column in a Selda table and its corresponding database column.

Instances

Eq ColumnDiff Source #
Instance details Defined in Database.Selda.Validation Methods (==) :: ColumnDiff -> ColumnDiff -> Bool # (/=) :: ColumnDiff -> ColumnDiff -> Bool #
Show ColumnDiff Source #
Instance details Defined in Database.Selda.Validation Methods showsPrec :: Int -> ColumnDiff -> ShowS # show :: ColumnDiff -> String # showList :: [ColumnDiff] -> ShowS #

data TableName Source #

Name of a database table.

Instances

Eq TableName Source #
Instance details Defined in Database.Selda.Types Methods (==) :: TableName -> TableName -> Bool # (/=) :: TableName -> TableName -> Bool #
Ord TableName Source #
Instance details Defined in Database.Selda.Types Methods compare :: TableName -> TableName -> Ordering # (<) :: TableName -> TableName -> Bool # (<=) :: TableName -> TableName -> Bool # (>) :: TableName -> TableName -> Bool # (>=) :: TableName -> TableName -> Bool # max :: TableName -> TableName -> TableName # min :: TableName -> TableName -> TableName #
Show TableName Source #
Instance details Defined in Database.Selda.Types Methods showsPrec :: Int -> TableName -> ShowS # show :: TableName -> String # showList :: [TableName] -> ShowS #
IsString TableName Source #
Instance details Defined in Database.Selda.Types Methods fromString :: String -> TableName #

data ColName Source #

Name of a database column.

Instances

Eq ColName Source #
Instance details Defined in Database.Selda.Types Methods (==) :: ColName -> ColName -> Bool # (/=) :: ColName -> ColName -> Bool #
Ord ColName Source #
Instance details Defined in Database.Selda.Types Methods compare :: ColName -> ColName -> Ordering # (<) :: ColName -> ColName -> Bool # (<=) :: ColName -> ColName -> Bool # (>) :: ColName -> ColName -> Bool # (>=) :: ColName -> ColName -> Bool # max :: ColName -> ColName -> ColName # min :: ColName -> ColName -> ColName #
Show ColName Source #
Instance details Defined in Database.Selda.Types Methods showsPrec :: Int -> ColName -> ShowS # show :: ColName -> String # showList :: [ColName] -> ShowS #
IsString ColName Source #
Instance details Defined in Database.Selda.Types Methods fromString :: String -> ColName #

data ColumnInfo Source #

Comprehensive information about a column.

Instances

Eq ColumnInfo Source #
Instance details Defined in Database.Selda.Backend.Internal Methods (==) :: ColumnInfo -> ColumnInfo -> Bool # (/=) :: ColumnInfo -> ColumnInfo -> Bool #
Show ColumnInfo Source #
Instance details Defined in Database.Selda.Backend.Internal Methods showsPrec :: Int -> ColumnInfo -> ShowS # show :: ColumnInfo -> String # showList :: [ColumnInfo] -> ShowS #

data SqlTypeRep Source #

Representation of an SQL type.

Instances

Eq SqlTypeRep Source #
Instance details Defined in Database.Selda.SqlType Methods (==) :: SqlTypeRep -> SqlTypeRep -> Bool # (/=) :: SqlTypeRep -> SqlTypeRep -> Bool #
Ord SqlTypeRep Source #
Instance details Defined in Database.Selda.SqlType Methods compare :: SqlTypeRep -> SqlTypeRep -> Ordering # (<) :: SqlTypeRep -> SqlTypeRep -> Bool # (<=) :: SqlTypeRep -> SqlTypeRep -> Bool # (>) :: SqlTypeRep -> SqlTypeRep -> Bool # (>=) :: SqlTypeRep -> SqlTypeRep -> Bool # max :: SqlTypeRep -> SqlTypeRep -> SqlTypeRep # min :: SqlTypeRep -> SqlTypeRep -> SqlTypeRep #
Show SqlTypeRep Source #
Instance details Defined in Database.Selda.SqlType Methods showsPrec :: Int -> SqlTypeRep -> ShowS # show :: SqlTypeRep -> String # showList :: [SqlTypeRep] -> ShowS #

tableInfo :: Table a -> TableInfo Source #

Get the column information for each column in the given table.

showTableDiff :: TableDiff -> Text Source #

Pretty-print a table diff.

showColumnDiff :: ColumnDiff -> Text Source #

Pretty-print a column diff.

describeTable :: MonadSelda m => TableName -> m TableInfo Source #

Get a description of the table by the given name currently in the database.

diffTable :: MonadSelda m => Table a -> m TableDiff Source #

Check the given table for consistency with the current database, returning a description of all inconsistencies found. The table schema itself is not validated beforehand.

diffTables :: Table a -> Table b -> TableDiff Source #

Compute the difference between the two given tables. The first table is considered to be the schema, and the second the database.

validateTable :: (MonadSelda m, MonadThrow m) => Table a -> m () Source #

Validate a table schema, and check it for consistency against the current database. Throws a ValidationError if the schema does not validate, or if inconsistencies were found.

validateSchema :: MonadThrow m => Table a -> m () Source #

Ensure that the schema of the given table is valid. Does not ensure consistency with the current database.

ColumnMissing
ColumnPresent
NameMismatch ColName
UnknownType Text
TypeMismatch SqlTypeRep SqlTypeRep
AutoIncrementMismatch Bool
NullableMismatch Bool
ForeignKeyMissing TableName ColName
ForeignKeyPresent TableName ColName
IndexMismatch Bool