Copyright	Flipstone Technology Partners 2023
License	MIT
Stability	Stable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Orville.PostgreSQL.PgCatalog

Description

Since: 1.0.0.0

Synopsis

data PgSequence = PgSequence {
- pgSequenceClassOid :: Oid
- pgSequenceTypeOid :: Oid
- pgSequenceStart :: Int64
- pgSequenceIncrement :: Int64
- pgSequenceMax :: Int64
- pgSequenceMin :: Int64
- pgSequenceCache :: Int64
- pgSequenceCycle :: Bool
}
pgSequenceTable :: TableDefinition (HasKey Oid) PgSequence PgSequence
sequencePgClassOidField :: FieldDefinition NotNull Oid
data PgNamespace = PgNamespace {
- pgNamespaceOid :: Oid
- pgNamespaceName :: NamespaceName
}
data NamespaceName
namespaceNameToString :: NamespaceName -> String
pgNamespaceTable :: TableDefinition (HasKey Oid) PgNamespace PgNamespace
namespaceNameField :: FieldDefinition NotNull NamespaceName
data PgIndex = PgIndex {
- pgIndexPgClassOid :: Oid
- pgIndexRelationOid :: Oid
- pgIndexAttributeNumbers :: [AttributeNumber]
- pgIndexIsUnique :: Bool
- pgIndexIsPrimary :: Bool
- pgIndexIsLive :: Bool
}
pgIndexTable :: TableDefinition NoKey PgIndex PgIndex
indexRelationOidField :: FieldDefinition NotNull Oid
indexIsLiveField :: FieldDefinition NotNull Bool
data PgConstraint = PgConstraint {
- pgConstraintOid :: Oid
- pgConstraintName :: ConstraintName
- pgConstraintNamespaceOid :: Oid
- pgConstraintType :: ConstraintType
- pgConstraintRelationOid :: Oid
- pgConstraintIndexOid :: Oid
- pgConstraintKey :: Maybe [AttributeNumber]
- pgConstraintForeignRelationOid :: Oid
- pgConstraintForeignKey :: Maybe [AttributeNumber]
- pgConstraintForeignKeyOnUpdateType :: Maybe ForeignKeyAction
- pgConstraintForeignKeyOnDeleteType :: Maybe ForeignKeyAction
}
data ConstraintType
- = CheckConstraint
- | ForeignKeyConstraint
- | PrimaryKeyConstraint
- | UniqueConstraint
- | ConstraintTrigger
- | ExclusionConstraint
data ConstraintName
constraintNameToString :: ConstraintName -> String
pgConstraintTable :: TableDefinition (HasKey Oid) PgConstraint PgConstraint
constraintRelationOidField :: FieldDefinition NotNull Oid
data PgClass = PgClass {
- pgClassOid :: Oid
- pgClassNamespaceOid :: Oid
- pgClassRelationName :: RelationName
- pgClassRelationKind :: RelationKind
}
data RelationName
relationNameToString :: RelationName -> String
data RelationKind
- = OrdinaryTable
- | Index
- | Sequence
- | ToastTable
- | View
- | MaterializedView
- | CompositeType
- | ForeignTable
- | PartitionedTable
- | PartitionedIndex
pgClassTable :: TableDefinition (HasKey Oid) PgClass PgClass
relationNameField :: FieldDefinition NotNull RelationName
namespaceOidField :: FieldDefinition NotNull Oid
relationKindField :: FieldDefinition NotNull RelationKind
data PgAttributeDefault = PgAttributeDefault {
- pgAttributeDefaultOid :: Oid
- pgAttributeDefaultRelationOid :: Oid
- pgAttributeDefaultAttributeNumber :: AttributeNumber
- pgAttributeDefaultExpression :: Text
}
pgAttributeDefaultTable :: TableDefinition NoKey PgAttributeDefault PgAttributeDefault
attributeDefaultRelationOidField :: FieldDefinition NotNull Oid
data PgAttribute = PgAttribute {
- pgAttributeRelationOid :: Oid
- pgAttributeName :: AttributeName
- pgAttributeNumber :: AttributeNumber
- pgAttributeTypeOid :: Oid
- pgAttributeLength :: Int16
- pgAttributeTypeModifier :: Int32
- pgAttributeIsDropped :: Bool
- pgAttributeIsNotNull :: Bool
}
pgAttributeMaxLength :: PgAttribute -> Maybe Int32
data AttributeName
attributeNameToString :: AttributeName -> String
data AttributeNumber
attributeNumberToInt16 :: AttributeNumber -> Int16
attributeNumberFromInt16 :: Int16 -> AttributeNumber
attributeNumberTextBuilder :: AttributeNumber -> Builder
attributeNumberParser :: Parser AttributeNumber
isOrdinaryColumn :: PgAttribute -> Bool
pgAttributeTable :: TableDefinition NoKey PgAttribute PgAttribute
attributeRelationOidField :: FieldDefinition NotNull Oid
attributeNameField :: FieldDefinition NotNull AttributeName
attributeTypeOidField :: FieldDefinition NotNull Oid
attributeLengthField :: FieldDefinition NotNull Int16
attributeIsDroppedField :: FieldDefinition NotNull Bool
attributeNumberTypeField :: String -> FieldDefinition NotNull AttributeNumber
oidField :: FieldDefinition NotNull Oid
oidTypeField :: String -> FieldDefinition NotNull Oid
data DatabaseDescription = DatabaseDescription {
- databaseRelations :: Map (NamespaceName, RelationName) RelationDescription
}
data RelationDescription = RelationDescription {
- relationRecord :: PgClass
- relationAttributes :: Map AttributeName PgAttribute
- relationAttributeDefaults :: Map AttributeNumber PgAttributeDefault
- relationConstraints :: [ConstraintDescription]
- relationIndexes :: [IndexDescription]
- relationSequence :: Maybe PgSequence
}
data ConstraintDescription = ConstraintDescription {
- constraintRecord :: PgConstraint
- constraintKey :: Maybe [PgAttribute]
- constraintForeignRelation :: Maybe ForeignRelationDescription
- constraintForeignKey :: Maybe [PgAttribute]
}
data ForeignRelationDescription = ForeignRelationDescription {
- foreignRelationClass :: PgClass
- foreignRelationNamespace :: PgNamespace
}
data IndexDescription = IndexDescription {
- indexRecord :: PgIndex
- indexPgClass :: PgClass
- indexMembers :: [IndexMember]
}
data IndexMember
- = IndexAttribute PgAttribute
- | IndexExpression
lookupRelation :: (NamespaceName, RelationName) -> DatabaseDescription -> Maybe RelationDescription
lookupRelationOfKind :: RelationKind -> (NamespaceName, RelationName) -> DatabaseDescription -> Maybe RelationDescription
lookupAttribute :: AttributeName -> RelationDescription -> Maybe PgAttribute
lookupAttributeDefault :: PgAttribute -> RelationDescription -> Maybe PgAttributeDefault
describeDatabaseRelations :: MonadOrville m => [(NamespaceName, RelationName)] -> m DatabaseDescription

Documentation

data PgSequence Source #

The Haskell representation of data read from the pg_catalog.pg_sequence table. Rows in this table are sequences in PostgreSQL.

Since: 1.0.0.0

Constructors

PgSequence

Fields

pgSequenceClassOid :: Oid
The PostgreSQL oid of the pg_class for this sequence.
pgSequenceTypeOid :: Oid
The PostgreSQL oid of the data type of the sequence. References pg_type.oid.
pgSequenceStart :: Int64
The start value of the sequence.
pgSequenceIncrement :: Int64
The increment value of the sequence.
pgSequenceMax :: Int64
The max value of the sequence.
pgSequenceMin :: Int64
The min value of the sequence.
pgSequenceCache :: Int64
The cache size of the sequence.
pgSequenceCycle :: Bool
Whether the sequence cycles.

pgSequenceTable :: TableDefinition (HasKey Oid) PgSequence PgSequence Source #

An Orville TableDefinition for querying the pg_catalog.pg_sequence table.

Since: 1.0.0.0

sequencePgClassOidField :: FieldDefinition NotNull Oid Source #

The seqrelid column of the pg_cataglog.pg_sequence table.

Since: 1.0.0.0

data PgNamespace Source #

The Haskell representation of data read from the pg_catalog.pg_namespace table. Namespaces in pg_catalog correspond to "schema" concept in database organization.

Since: 1.0.0.0

Constructors

PgNamespace
Fields pgNamespaceOid :: Oid The PostgreSQL `oid` for the namespace. This is referenced from other tables, such as `pg_class`. pgNamespaceName :: NamespaceName The name of the namespace.

data NamespaceName Source #

A Haskell type for the name of a namespace.

Since: 1.0.0.0

Instances

Instances details

IsString NamespaceName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgNamespace Methods fromString :: String -> NamespaceName #
Show NamespaceName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgNamespace Methods showsPrec :: Int -> NamespaceName -> ShowS # show :: NamespaceName -> String # showList :: [NamespaceName] -> ShowS #
Eq NamespaceName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgNamespace Methods (==) :: NamespaceName -> NamespaceName -> Bool # (/=) :: NamespaceName -> NamespaceName -> Bool #
Ord NamespaceName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgNamespace Methods compare :: NamespaceName -> NamespaceName -> Ordering # (<) :: NamespaceName -> NamespaceName -> Bool # (<=) :: NamespaceName -> NamespaceName -> Bool # (>) :: NamespaceName -> NamespaceName -> Bool # (>=) :: NamespaceName -> NamespaceName -> Bool # max :: NamespaceName -> NamespaceName -> NamespaceName # min :: NamespaceName -> NamespaceName -> NamespaceName #

namespaceNameToString :: NamespaceName -> String Source #

Convert a NamespaceName to a plain String.

Since: 1.0.0.0

pgNamespaceTable :: TableDefinition (HasKey Oid) PgNamespace PgNamespace Source #

An Orville TableDefinition for querying the pg_catalog.pg_namespace table.

Since: 1.0.0.0

namespaceNameField :: FieldDefinition NotNull NamespaceName Source #

The nspname column of the pg_catalog.pg_namespace table.

Since: 1.0.0.0

data PgIndex Source #

The Haskell representation of data read from the pg_catalog.pg_index table. Rows in this table contain extended information about indices. Information about indices is also contained in the pg_catalog.pg_class table as well.

Since: 1.0.0.0

Constructors

PgIndex

Fields

pgIndexPgClassOid :: Oid
The PostgreSQL oid of the pg_class entry for this index.
pgIndexRelationOid :: Oid
The PostgreSQL oid of the pg_class entry for the table that this index is for.
pgIndexAttributeNumbers :: [AttributeNumber]
An array of attribute number references for the columns of the table that are included in the index. An attribute number of 0 indicates an expression over the table's columns rather than just a reference to a column.
In PostgreSQL 11+ this includes both key columns and non-key-included columns. Orville is currently not aware of this distinction, however.
pgIndexIsUnique :: Bool
Indicates whether this is a unique index.
pgIndexIsPrimary :: Bool
Indicates whether this is the primary key index for the table.
pgIndexIsLive :: Bool
When False, indicates that this index is in the process of being dropped and should be ignored.

pgIndexTable :: TableDefinition NoKey PgIndex PgIndex Source #

An Orville TableDefinition for querying the pg_catalog.pg_index table.

Since: 1.0.0.0

indexRelationOidField :: FieldDefinition NotNull Oid Source #

The indrelid column of the pg_index table.

Since: 1.0.0.0

indexIsLiveField :: FieldDefinition NotNull Bool Source #

The indislive column of the pg_index table.

Since: 1.0.0.0

data PgConstraint Source #

The Haskell representation of data read from the pg_catalog.pg_constraint table. Rows in this table correspond to check, primary key, unique, foreign key and exclusion constraints on tables.

Since: 1.0.0.0

Constructors

PgConstraint

Fields

pgConstraintOid :: Oid
The PostgreSQL oid for the constraint.
pgConstraintName :: ConstraintName
The constraint name (which may not be unique).
pgConstraintNamespaceOid :: Oid
The oid of the namespace that contains the constraint.
pgConstraintType :: ConstraintType
The type of constraint.
pgConstraintRelationOid :: Oid
The PostgreSQL oid of the table that the constraint is on (or 0 if not a table constraint).
pgConstraintIndexOid :: Oid
The PostgreSQL oid ef the index supporting this constraint, if it's a unique, primary key, foreign key or exclusion constraint. Otherwise 0.
pgConstraintKey :: Maybe [AttributeNumber]
For table constraints, the attribute numbers of the constrained columns. These correspond to the pgAttributeNumber field of PgAttribute.
pgConstraintForeignRelationOid :: Oid
For foreign key constraints, the PostgreSQL oid of the table the foreign key references.
pgConstraintForeignKey :: Maybe [AttributeNumber]
For foreign key constraints, the attribute numbers of the referenced columns. These correspond to the pgAttributeNumber field of PgAttribute.
pgConstraintForeignKeyOnUpdateType :: Maybe ForeignKeyAction
For foreign key constraints, the on update action type.
pgConstraintForeignKeyOnDeleteType :: Maybe ForeignKeyAction
For foreign key constraints, the on delete action type.

data ConstraintType Source #

The type of constraint that a PgConstraint represents, as described at https://www.postgresql.org/docs/13/catalog-pg-constraint.html.

Since: 1.0.0.0

Constructors

CheckConstraint
ForeignKeyConstraint
PrimaryKeyConstraint
UniqueConstraint
ConstraintTrigger
ExclusionConstraint

Instances

Instances details

Show ConstraintType Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgConstraint Methods showsPrec :: Int -> ConstraintType -> ShowS # show :: ConstraintType -> String # showList :: [ConstraintType] -> ShowS #
Eq ConstraintType Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgConstraint Methods (==) :: ConstraintType -> ConstraintType -> Bool # (/=) :: ConstraintType -> ConstraintType -> Bool #

data ConstraintName Source #

A Haskell type for the name of the constraint represented by a PgConstraint.

Since: 1.0.0.0

Instances

Instances details

IsString ConstraintName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgConstraint Methods fromString :: String -> ConstraintName #
Show ConstraintName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgConstraint Methods showsPrec :: Int -> ConstraintName -> ShowS # show :: ConstraintName -> String # showList :: [ConstraintName] -> ShowS #
Eq ConstraintName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgConstraint Methods (==) :: ConstraintName -> ConstraintName -> Bool # (/=) :: ConstraintName -> ConstraintName -> Bool #
Ord ConstraintName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgConstraint Methods compare :: ConstraintName -> ConstraintName -> Ordering # (<) :: ConstraintName -> ConstraintName -> Bool # (<=) :: ConstraintName -> ConstraintName -> Bool # (>) :: ConstraintName -> ConstraintName -> Bool # (>=) :: ConstraintName -> ConstraintName -> Bool # max :: ConstraintName -> ConstraintName -> ConstraintName # min :: ConstraintName -> ConstraintName -> ConstraintName #

constraintNameToString :: ConstraintName -> String Source #

Converts a ConstraintName to a plain String.

Since: 1.0.0.0

pgConstraintTable :: TableDefinition (HasKey Oid) PgConstraint PgConstraint Source #

An Orville TableDefinition for querying the pg_catalog.pg_constraint table.

Since: 1.0.0.0

constraintRelationOidField :: FieldDefinition NotNull Oid Source #

The conrelid column of the pg_constraint table.

Since: 1.0.0.0

data PgClass Source #

The Haskell representation of data read from the pg_catalog.pg_class table. Rows in this table correspond to tables, indexes, sequences, views, materialized views, composite types and TOAST tables.

Since: 1.0.0.0

Constructors

PgClass
Fields pgClassOid :: Oid The PostgreSQL `oid` for the relation. pgClassNamespaceOid :: Oid The PostgreSQL `oid` of the namespace that the relation belongs to. References `pg_namespace.oid`. pgClassRelationName :: RelationName The name of the relation. pgClassRelationKind :: RelationKind The kind of relation (table, view, etc).

data RelationName Source #

A Haskell type for the name of the relation represented by a PgClass.

Since: 1.0.0.0

Instances

Instances details

IsString RelationName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgClass Methods fromString :: String -> RelationName #
Show RelationName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgClass Methods showsPrec :: Int -> RelationName -> ShowS # show :: RelationName -> String # showList :: [RelationName] -> ShowS #
Eq RelationName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgClass Methods (==) :: RelationName -> RelationName -> Bool # (/=) :: RelationName -> RelationName -> Bool #
Ord RelationName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgClass Methods compare :: RelationName -> RelationName -> Ordering # (<) :: RelationName -> RelationName -> Bool # (<=) :: RelationName -> RelationName -> Bool # (>) :: RelationName -> RelationName -> Bool # (>=) :: RelationName -> RelationName -> Bool # max :: RelationName -> RelationName -> RelationName # min :: RelationName -> RelationName -> RelationName #

relationNameToString :: RelationName -> String Source #

Convert a RelationName to a plain String.

Since: 1.0.0.0

data RelationKind Source #

The kind of relation represented by a PgClass, as described at https://www.postgresql.org/docs/13/catalog-pg-class.html.

Since: 1.0.0.0

Constructors

OrdinaryTable
Index
Sequence
ToastTable
View
MaterializedView
CompositeType
ForeignTable
PartitionedTable
PartitionedIndex

Instances

Instances details

Show RelationKind Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgClass Methods showsPrec :: Int -> RelationKind -> ShowS # show :: RelationKind -> String # showList :: [RelationKind] -> ShowS #
Eq RelationKind Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgClass Methods (==) :: RelationKind -> RelationKind -> Bool # (/=) :: RelationKind -> RelationKind -> Bool #

pgClassTable :: TableDefinition (HasKey Oid) PgClass PgClass Source #

An Orville TableDefinition for querying the pg_catalog.pg_class table.

Since: 1.0.0.0

relationNameField :: FieldDefinition NotNull RelationName Source #

The relname column of the pg_catalog.pg_class table.

Since: 1.0.0.0

namespaceOidField :: FieldDefinition NotNull Oid Source #

The relnamespace column of the pg_catalog.pg_class table.

Since: 1.0.0.0

relationKindField :: FieldDefinition NotNull RelationKind Source #

The relkind column of the pg_catalog.pg_class table.

Since: 1.0.0.0

data PgAttributeDefault Source #

The Haskell representation of data read from the pg_catalog.pg_attrdef table.

Since: 1.0.0.0

Constructors

PgAttributeDefault

Fields

pgAttributeDefaultOid :: Oid
The PostgreSQL oid for the default value.
pgAttributeDefaultRelationOid :: Oid
The PostgreSQL oid for the relation that this attribute belongs to. References pg_class.oid.
pgAttributeDefaultAttributeNumber :: AttributeNumber
The PostgreSQL attribute number for the column that this default belongs to. References pg_attribute.attnum.
pgAttributeDefaultExpression :: Text
The PostgreSQL default value expression, as decompiled from the adbin column using the PostgreSQL pg_get_expr function.

pgAttributeDefaultTable :: TableDefinition NoKey PgAttributeDefault PgAttributeDefault Source #

An Orville TableDefinition for querying the pg_catalog.pg_attrdef table.

Since: 1.0.0.0

attributeDefaultRelationOidField :: FieldDefinition NotNull Oid Source #

The adrelid column of the pg_catalog.pg_attrdef table.

Since: 1.0.0.0

data PgAttribute Source #

The Haskell representation of data read from the pg_catalog.pg_attribute table. Rows in this table correspond to table columns, but also to attributes of other items from the pg_class table.

Instances

Instances details

IsString AttributeName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods fromString :: String -> AttributeName #
Show AttributeName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods showsPrec :: Int -> AttributeName -> ShowS # show :: AttributeName -> String # showList :: [AttributeName] -> ShowS #
Eq AttributeName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods (==) :: AttributeName -> AttributeName -> Bool # (/=) :: AttributeName -> AttributeName -> Bool #
Ord AttributeName Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods compare :: AttributeName -> AttributeName -> Ordering # (<) :: AttributeName -> AttributeName -> Bool # (<=) :: AttributeName -> AttributeName -> Bool # (>) :: AttributeName -> AttributeName -> Bool # (>=) :: AttributeName -> AttributeName -> Bool # max :: AttributeName -> AttributeName -> AttributeName # min :: AttributeName -> AttributeName -> AttributeName #

attributeNameToString :: AttributeName -> String Source #

Converts an AttributeName to a plain String.

Since: 1.0.0.0

data AttributeNumber Source #

A Haskell type for the number of the attribute represented by a PgAttribute.

Since: 1.0.0.0

Instances

Instances details

Enum AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods succ :: AttributeNumber -> AttributeNumber # pred :: AttributeNumber -> AttributeNumber # toEnum :: Int -> AttributeNumber # fromEnum :: AttributeNumber -> Int # enumFrom :: AttributeNumber -> [AttributeNumber] # enumFromThen :: AttributeNumber -> AttributeNumber -> [AttributeNumber] # enumFromTo :: AttributeNumber -> AttributeNumber -> [AttributeNumber] # enumFromThenTo :: AttributeNumber -> AttributeNumber -> AttributeNumber -> [AttributeNumber] #
Num AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods (+) :: AttributeNumber -> AttributeNumber -> AttributeNumber # (-) :: AttributeNumber -> AttributeNumber -> AttributeNumber # (*) :: AttributeNumber -> AttributeNumber -> AttributeNumber # negate :: AttributeNumber -> AttributeNumber # abs :: AttributeNumber -> AttributeNumber # signum :: AttributeNumber -> AttributeNumber # fromInteger :: Integer -> AttributeNumber #
Integral AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods quot :: AttributeNumber -> AttributeNumber -> AttributeNumber # rem :: AttributeNumber -> AttributeNumber -> AttributeNumber # div :: AttributeNumber -> AttributeNumber -> AttributeNumber # mod :: AttributeNumber -> AttributeNumber -> AttributeNumber # quotRem :: AttributeNumber -> AttributeNumber -> (AttributeNumber, AttributeNumber) # divMod :: AttributeNumber -> AttributeNumber -> (AttributeNumber, AttributeNumber) # toInteger :: AttributeNumber -> Integer #
Real AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods toRational :: AttributeNumber -> Rational #
Show AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods showsPrec :: Int -> AttributeNumber -> ShowS # show :: AttributeNumber -> String # showList :: [AttributeNumber] -> ShowS #
Eq AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods (==) :: AttributeNumber -> AttributeNumber -> Bool # (/=) :: AttributeNumber -> AttributeNumber -> Bool #
Ord AttributeNumber Source #
Instance details Defined in Orville.PostgreSQL.PgCatalog.PgAttribute Methods compare :: AttributeNumber -> AttributeNumber -> Ordering # (<) :: AttributeNumber -> AttributeNumber -> Bool # (<=) :: AttributeNumber -> AttributeNumber -> Bool # (>) :: AttributeNumber -> AttributeNumber -> Bool # (>=) :: AttributeNumber -> AttributeNumber -> Bool # max :: AttributeNumber -> AttributeNumber -> AttributeNumber # min :: AttributeNumber -> AttributeNumber -> AttributeNumber #

attributeNumberToInt16 :: AttributeNumber -> Int16 Source #

Converts an AttributeNumber to an integer.

attributeNumberFromInt16 :: Int16 -> AttributeNumber Source #

Converts an integer to an AttributeNumber.

attributeNumberTextBuilder :: AttributeNumber -> Builder Source #

Encodes an AttributeNumber to lazy text as a builder.

Since: 1.0.0.0

attributeNumberParser :: Parser AttributeNumber Source #

Attoparsec parser for AttributeNumber.

Since: 1.0.0.0

isOrdinaryColumn :: PgAttribute -> Bool Source #

Determines whether the attribute represents a system column by inspecting the attribute's AttributeNumber. Ordinary columns have attribute numbers starting at 1.

Since: 1.0.0.0

pgAttributeTable :: TableDefinition NoKey PgAttribute PgAttribute Source #

An Orville TableDefinition for querying the pg_catalog.pg_attribute table.

Since: 1.0.0.0

attributeRelationOidField :: FieldDefinition NotNull Oid Source #

The attrelid column of the pg_catalog.pg_attribute table.

Since: 1.0.0.0

attributeNameField :: FieldDefinition NotNull AttributeName Source #

The attname column of the pg_catalog.pg_attribute table.

Since: 1.0.0.0

attributeTypeOidField :: FieldDefinition NotNull Oid Source #

The atttypid column of the pg_catalog.pg_attribute table.

Since: 1.0.0.0

attributeLengthField :: FieldDefinition NotNull Int16 Source #

The attlen column of the pg_catalog.pg_attribute table.

Since: 1.0.0.0

attributeIsDroppedField :: FieldDefinition NotNull Bool Source #

The attisdropped column of the pg_catalog.pg_attribute table.

Since: 1.0.0.0

attributeNumberTypeField :: String -> FieldDefinition NotNull AttributeNumber Source #

Builds a FieldDefinition for a field with type AttributeNumber.

Since: 1.0.0.0

oidField :: FieldDefinition NotNull Oid Source #

The oid field found on many (but not all!) pg_catalog tables.

Since: 1.0.0.0

oidTypeField :: String -> FieldDefinition NotNull Oid Source #

Builds a FieldDefinition with the given column name that stores an oid value.

Since: 1.0.0.0

data DatabaseDescription Source #

A description of selected items from a single PostgreSQL database. describeDatabaseRelations can be used to load the descriptions of request items.

Since: 1.0.0.0

Constructors

DatabaseDescription
Fields databaseRelations :: Map (NamespaceName, RelationName) RelationDescription

data RelationDescription Source #

A description of a particular relation in the PostgreSQL database, including the attributes of the relation.

Since: 1.0.0.0

Constructors

RelationDescription
Fields relationRecord :: PgClass relationAttributes :: Map AttributeName PgAttribute relationAttributeDefaults :: Map AttributeNumber PgAttributeDefault relationConstraints :: [ConstraintDescription] relationIndexes :: [IndexDescription] relationSequence :: Maybe PgSequence

data ConstraintDescription Source #

A description of a particular constraint in the PostgreSQL database, including the attributes and relations that it references.

Since: 1.0.0.0

Constructors

ConstraintDescription
Fields constraintRecord :: PgConstraint constraintKey :: Maybe [PgAttribute] constraintForeignRelation :: Maybe ForeignRelationDescription constraintForeignKey :: Maybe [PgAttribute]

data ForeignRelationDescription Source #

A description of a relation in the PostgreSQL database that is referenced by a foreign key constraint, including the namespace that the relation belongs to.

Since: 1.0.0.0

Constructors

ForeignRelationDescription
Fields foreignRelationClass :: PgClass foreignRelationNamespace :: PgNamespace

data IndexDescription Source #

A description of an index in the PostgreSQL database, including the names of the attributes included in the index and the PgClass record of the index itself (NOT the PgClass of the table that the index is for).

Since: 1.0.0.0

Constructors

IndexDescription
Fields indexRecord :: PgIndex indexPgClass :: PgClass indexMembers :: [IndexMember]

data IndexMember Source #

A description of an index member in the PostgreSQL database. If the member is a simple attribute, the PgAttribute for that is provided. If it is an index over an expression, no further description is currently provided.

Since: 1.0.0.0

Constructors

IndexAttribute PgAttribute
IndexExpression

lookupRelation :: (NamespaceName, RelationName) -> DatabaseDescription -> Maybe RelationDescription Source #

Lookup a relation by its qualified name in the pg_catalog schema.

Since: 1.0.0.0

lookupRelationOfKind :: RelationKind -> (NamespaceName, RelationName) -> DatabaseDescription -> Maybe RelationDescription Source #

Lookup a relation by its qualified name in the pg_catalog schema. If the relation is not of the expected kind, Nothing is returned.

Since: 1.0.0.0

lookupAttribute :: AttributeName -> RelationDescription -> Maybe PgAttribute Source #

Find an attribute by name from the RelationDescription.

Since: 1.0.0.0

lookupAttributeDefault :: PgAttribute -> RelationDescription -> Maybe PgAttributeDefault Source #

Find an attribute default from the RelationDescription.

Since: 1.0.0.0

describeDatabaseRelations :: MonadOrville m => [(NamespaceName, RelationName)] -> m DatabaseDescription Source #

Describes the requested relations in the current database. If any of the relations do not exist, they will not have an entry in the returned description.

Each RelationDescription will contain all the attributes that currently exist for that relation, according to the pg_catalog tables.

Since: 1.0.0.0