Database.Selda.Validation

Utilities for validating and inspecting Selda tables.

Documentation

data TableDiff

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

Constructors

TableOK

TableMissing

InconsistentColumns [(ColName, [ColumnDiff])]

Instances

Eq TableDiff

Defined in Database.Selda.Validation

Methods

(==) :: TableDiff -> TableDiff -> Bool

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

Show TableDiff

Defined in Database.Selda.Validation

Methods

showsPrec :: Int -> TableDiff -> ShowS

show :: TableDiff -> String

showList :: [TableDiff] -> ShowS

data ColumnDiff

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

Constructors

ColumnMissing

ColumnPresent

NameMismatch ColName

UnknownType Text

TypeMismatch SqlTypeRep SqlTypeRep

PrimaryKeyMismatch Bool

AutoIncrementMismatch Bool

NullableMismatch Bool

UniqueMismatch Bool

ForeignKeyMissing TableName ColName

ForeignKeyPresent TableName ColName

IndexMissing

IndexPresent

Instances

Eq ColumnDiff

Defined in Database.Selda.Validation

Methods

(==) :: ColumnDiff -> ColumnDiff -> Bool

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

Show ColumnDiff

Defined in Database.Selda.Validation

Methods

showsPrec :: Int -> ColumnDiff -> ShowS

show :: ColumnDiff -> String

showList :: [ColumnDiff] -> ShowS

data TableName

Name of a database table.

Instances

Eq TableName

Defined in Database.Selda.Types

Methods

(==) :: TableName -> TableName -> Bool

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

Ord TableName

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

Defined in Database.Selda.Types

Methods

showsPrec :: Int -> TableName -> ShowS

show :: TableName -> String

showList :: [TableName] -> ShowS

IsString TableName

Defined in Database.Selda.Types

Methods

fromString :: String -> TableName

Hashable TableName

Defined in Database.Selda.Types

Methods

hashWithSalt :: Int -> TableName -> Int

hash :: TableName -> Int

data ColName

Name of a database column.

Instances

Eq ColName

Defined in Database.Selda.Types

Methods

(==) :: ColName -> ColName -> Bool

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

Ord ColName

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

Defined in Database.Selda.Types

Methods

showsPrec :: Int -> ColName -> ShowS

show :: ColName -> String

showList :: [ColName] -> ShowS

IsString ColName

Defined in Database.Selda.Types

Methods

fromString :: String -> ColName

data ColumnInfo

Comprehensive information about a column.

Instances

Eq ColumnInfo

Defined in Database.Selda.Backend.Internal

Methods

(==) :: ColumnInfo -> ColumnInfo -> Bool

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

Show ColumnInfo

Defined in Database.Selda.Backend.Internal

Methods

showsPrec :: Int -> ColumnInfo -> ShowS

show :: ColumnInfo -> String

showList :: [ColumnInfo] -> ShowS

data SqlTypeRep

Representation of an SQL type.

Instances

Eq SqlTypeRep

Defined in Database.Selda.SqlType

Methods

(==) :: SqlTypeRep -> SqlTypeRep -> Bool

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

Ord SqlTypeRep

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

Defined in Database.Selda.SqlType

Methods

showsPrec :: Int -> SqlTypeRep -> ShowS

show :: SqlTypeRep -> String

showList :: [SqlTypeRep] -> ShowS

columnInfo :: Table a -> [ColumnInfo]

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

showTableDiff :: TableDiff -> Text

Pretty-print a table diff.

showColumnDiff :: ColumnDiff -> Text

Pretty-print a column diff.

describeTable :: MonadSelda m => TableName -> m [ColumnInfo]

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

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

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

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 => Table a -> m ()

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 ()

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