Safe Haskell	None
Language	Haskell2010

PostgREST.DbStructure.Relationship

Synopsis

data Cardinality
- = O2M FKConstraint
- | M2O FKConstraint
- | M2M Junction
data PrimaryKey = PrimaryKey {
- pkTable :: Table
- pkName :: Text
}
data Relationship = Relationship {
- relTable :: Table
- relColumns :: [Column]
- relForeignTable :: Table
- relForeignColumns :: [Column]
- relCardinality :: Cardinality
}
data Junction = Junction {
- junTable :: Table
- junConstraint1 :: FKConstraint
- junColumns1 :: [Column]
- junConstraint2 :: FKConstraint
- junColumns2 :: [Column]
}
isSelfReference :: Relationship -> Bool

Documentation

data Cardinality Source #

The relationship cardinality | https://en.wikipedia.org/wiki/Cardinality_(data_modeling) TODO: missing one-to-one

Constructors

O2M FKConstraint	one-to-many cardinality
M2O FKConstraint	many-to-one cardinality
M2M Junction	many-to-many cardinality

Instances

Instances details

Eq Cardinality Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods (==) :: Cardinality -> Cardinality -> Bool # (/=) :: Cardinality -> Cardinality -> Bool #
Generic Cardinality Source #
Instance details Defined in PostgREST.DbStructure.Relationship Associated Types type Rep Cardinality :: Type -> Type # Methods from :: Cardinality -> Rep Cardinality x # to :: Rep Cardinality x -> Cardinality #
ToJSON Cardinality Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods toJSON :: Cardinality -> Value # toEncoding :: Cardinality -> Encoding # toJSONList :: [Cardinality] -> Value # toEncodingList :: [Cardinality] -> Encoding #
type Rep Cardinality Source #
Instance details Defined in PostgREST.DbStructure.Relationship type Rep Cardinality

data PrimaryKey Source #

Constructors

PrimaryKey
Fields pkTable :: Table pkName :: Text

Instances

Instances details

Generic PrimaryKey Source #
Instance details Defined in PostgREST.DbStructure.Relationship Associated Types type Rep PrimaryKey :: Type -> Type # Methods from :: PrimaryKey -> Rep PrimaryKey x # to :: Rep PrimaryKey x -> PrimaryKey #
ToJSON PrimaryKey Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods toJSON :: PrimaryKey -> Value # toEncoding :: PrimaryKey -> Encoding # toJSONList :: [PrimaryKey] -> Value # toEncodingList :: [PrimaryKey] -> Encoding #
type Rep PrimaryKey Source #
Instance details Defined in PostgREST.DbStructure.Relationship type Rep PrimaryKey = D1 ('MetaData "PrimaryKey" "PostgREST.DbStructure.Relationship" "postgrest-9.0.0-inplace" 'False) (C1 ('MetaCons "PrimaryKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "pkTable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Table) :*: S1 ('MetaSel ('Just "pkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Relationship Source #

Relationship between two tables.

The order of the relColumns and relForeignColumns should be maintained to get the join conditions right.

TODO merge relColumns and relForeignColumns to a tuple or Data.Bimap

Constructors

Relationship
Fields relTable :: Table relColumns :: [Column] relForeignTable :: Table relForeignColumns :: [Column] relCardinality :: Cardinality

Instances

Instances details

Eq Relationship Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods (==) :: Relationship -> Relationship -> Bool # (/=) :: Relationship -> Relationship -> Bool #
Generic Relationship Source #
Instance details Defined in PostgREST.DbStructure.Relationship Associated Types type Rep Relationship :: Type -> Type # Methods from :: Relationship -> Rep Relationship x # to :: Rep Relationship x -> Relationship #
ToJSON Relationship Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods toJSON :: Relationship -> Value # toEncoding :: Relationship -> Encoding # toJSONList :: [Relationship] -> Value # toEncodingList :: [Relationship] -> Encoding #
type Rep Relationship Source #
Instance details Defined in PostgREST.DbStructure.Relationship type Rep Relationship = D1 ('MetaData "Relationship" "PostgREST.DbStructure.Relationship" "postgrest-9.0.0-inplace" 'False) (C1 ('MetaCons "Relationship" 'PrefixI 'True) ((S1 ('MetaSel ('Just "relTable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Table) :: S1 ('MetaSel ('Just "relColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Column])) :: (S1 ('MetaSel ('Just "relForeignTable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Table) :: (S1 ('MetaSel ('Just "relForeignColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Column]) :: S1 ('MetaSel ('Just "relCardinality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cardinality)))))

data Junction Source #

Junction table on an M2M relationship

Constructors

Junction
Fields junTable :: Table junConstraint1 :: FKConstraint junColumns1 :: [Column] junConstraint2 :: FKConstraint junColumns2 :: [Column]

Instances

Instances details

Eq Junction Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods (==) :: Junction -> Junction -> Bool # (/=) :: Junction -> Junction -> Bool #
Generic Junction Source #
Instance details Defined in PostgREST.DbStructure.Relationship Associated Types type Rep Junction :: Type -> Type # Methods from :: Junction -> Rep Junction x # to :: Rep Junction x -> Junction #
ToJSON Junction Source #
Instance details Defined in PostgREST.DbStructure.Relationship Methods toJSON :: Junction -> Value # toEncoding :: Junction -> Encoding # toJSONList :: [Junction] -> Value # toEncodingList :: [Junction] -> Encoding #
type Rep Junction Source #
Instance details Defined in PostgREST.DbStructure.Relationship type Rep Junction

isSelfReference :: Relationship -> Bool Source #