Safe Haskell	None
Language	Haskell2010

Database.PostgreSQL.PQTypes.Model.ForeignKey

Synopsis

data ForeignKey = ForeignKey {
- fkColumns :: [RawSQL ()]
- fkRefTable :: RawSQL ()
- fkRefColumns :: [RawSQL ()]
- fkOnUpdate :: ForeignKeyAction
- fkOnDelete :: ForeignKeyAction
- fkDeferrable :: Bool
- fkDeferred :: Bool
- fkValidated :: Bool
}
data ForeignKeyAction
fkOnColumn :: RawSQL () -> RawSQL () -> RawSQL () -> ForeignKey
fkOnColumns :: [RawSQL ()] -> RawSQL () -> [RawSQL ()] -> ForeignKey
fkName :: RawSQL () -> ForeignKey -> RawSQL ()
sqlAddValidFKMaybeDowntime :: RawSQL () -> ForeignKey -> RawSQL ()
sqlAddNotValidFK :: RawSQL () -> ForeignKey -> RawSQL ()
sqlValidateFK :: RawSQL () -> ForeignKey -> RawSQL ()
sqlDropFK :: RawSQL () -> ForeignKey -> RawSQL ()

Documentation

data ForeignKey Source #

Constructors

ForeignKey
Fields fkColumns :: [RawSQL ()] fkRefTable :: RawSQL () fkRefColumns :: [RawSQL ()] fkOnUpdate :: ForeignKeyAction fkOnDelete :: ForeignKeyAction fkDeferrable :: Bool fkDeferred :: Bool fkValidated :: Bool Set to `False` if foreign key is created as NOT VALID and left in such state (for whatever reason).

Instances

Instances details

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

data ForeignKeyAction Source #

Constructors

ForeignKeyNoAction
ForeignKeyRestrict
ForeignKeyCascade
ForeignKeySetNull
ForeignKeySetDefault

Instances

Instances details

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

fkOnColumn :: RawSQL () -> RawSQL () -> RawSQL () -> ForeignKey Source #

fkOnColumns :: [RawSQL ()] -> RawSQL () -> [RawSQL ()] -> ForeignKey Source #

fkName :: RawSQL () -> ForeignKey -> RawSQL () Source #

sqlAddValidFKMaybeDowntime :: RawSQL () -> ForeignKey -> RawSQL () Source #

Add valid foreign key. Warning: PostgreSQL acquires SHARE ROW EXCLUSIVE lock (that prevents data updates) on both modified and referenced table for the duration of the creation. If this is not acceptable, use sqlAddNotValidFK and sqlValidateFK.

sqlAddNotValidFK :: RawSQL () -> ForeignKey -> RawSQL () Source #

Add foreign key marked as NOT VALID. This avoids potentially long validation blocking updates to both modified and referenced table for its duration. However, keys created as such need to be validated later using sqlValidateFK.

sqlValidateFK :: RawSQL () -> ForeignKey -> RawSQL () Source #

Validate foreign key previously created as NOT VALID.

sqlDropFK :: RawSQL () -> ForeignKey -> RawSQL () Source #