PostgREST.DbStructure.Proc

Documentation

data PgArg

Constructors

PgArg

Fields

• pgaName :: Text
• pgaType :: Text
• pgaReq :: Bool
• pgaVar :: Bool

Instances

Eq PgArg

Defined in PostgREST.DbStructure.Proc

Methods

(==) :: PgArg -> PgArg -> Bool

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

Ord PgArg

Defined in PostgREST.DbStructure.Proc

Methods

compare :: PgArg -> PgArg -> Ordering

(<) :: PgArg -> PgArg -> Bool

(<=) :: PgArg -> PgArg -> Bool

(>) :: PgArg -> PgArg -> Bool

(>=) :: PgArg -> PgArg -> Bool

max :: PgArg -> PgArg -> PgArg

min :: PgArg -> PgArg -> PgArg

Generic PgArg

Defined in PostgREST.DbStructure.Proc

Associated Types

type Rep PgArg :: Type -> Type

Methods

from :: PgArg -> Rep PgArg x

to :: Rep PgArg x -> PgArg

ToJSON PgArg

Defined in PostgREST.DbStructure.Proc

Methods

toJSON :: PgArg -> Value

toEncoding :: PgArg -> Encoding

toJSONList :: [PgArg] -> Value

toEncodingList :: [PgArg] -> Encoding

type Rep PgArg

Defined in PostgREST.DbStructure.Proc

type Rep PgArg = D1 ('MetaData "PgArg" "PostgREST.DbStructure.Proc" "postgrest-8.0.0-4wwkfqOKlk5GjHJ3yFP36o" 'False) (C1 ('MetaCons "PgArg" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pgaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "pgaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "pgaReq") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "pgaVar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data PgType

Constructors

Scalar

Composite QualifiedIdentifier

Instances

Eq PgType

Defined in PostgREST.DbStructure.Proc

Methods

(==) :: PgType -> PgType -> Bool

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

Ord PgType

Defined in PostgREST.DbStructure.Proc

Methods

compare :: PgType -> PgType -> Ordering

(<) :: PgType -> PgType -> Bool

(<=) :: PgType -> PgType -> Bool

(>) :: PgType -> PgType -> Bool

(>=) :: PgType -> PgType -> Bool

max :: PgType -> PgType -> PgType

min :: PgType -> PgType -> PgType

Generic PgType

Defined in PostgREST.DbStructure.Proc

Associated Types

type Rep PgType :: Type -> Type

Methods

from :: PgType -> Rep PgType x

to :: Rep PgType x -> PgType

ToJSON PgType

Defined in PostgREST.DbStructure.Proc

Methods

toJSON :: PgType -> Value

toEncoding :: PgType -> Encoding

toJSONList :: [PgType] -> Value

toEncodingList :: [PgType] -> Encoding

type Rep PgType

Defined in PostgREST.DbStructure.Proc

type Rep PgType = D1 ('MetaData "PgType" "PostgREST.DbStructure.Proc" "postgrest-8.0.0-4wwkfqOKlk5GjHJ3yFP36o" 'False) (C1 ('MetaCons "Scalar" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Composite" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 QualifiedIdentifier)))

data ProcDescription

Constructors

ProcDescription

Fields

• pdSchema :: Schema
• pdName :: Text
• pdDescription :: Maybe Text
• pdArgs :: [PgArg]
• pdReturnType :: RetType
• pdVolatility :: ProcVolatility
• pdHasVariadic :: Bool

Instances

Eq ProcDescription

Defined in PostgREST.DbStructure.Proc

Methods

(==) :: ProcDescription -> ProcDescription -> Bool

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

Ord ProcDescription

Defined in PostgREST.DbStructure.Proc

Methods

compare :: ProcDescription -> ProcDescription -> Ordering

(<) :: ProcDescription -> ProcDescription -> Bool

(<=) :: ProcDescription -> ProcDescription -> Bool

(>) :: ProcDescription -> ProcDescription -> Bool

(>=) :: ProcDescription -> ProcDescription -> Bool

max :: ProcDescription -> ProcDescription -> ProcDescription

min :: ProcDescription -> ProcDescription -> ProcDescription

Generic ProcDescription

Defined in PostgREST.DbStructure.Proc

Associated Types

type Rep ProcDescription :: Type -> Type

Methods

from :: ProcDescription -> Rep ProcDescription x

to :: Rep ProcDescription x -> ProcDescription

ToJSON ProcDescription

Defined in PostgREST.DbStructure.Proc

Methods

toJSON :: ProcDescription -> Value

toEncoding :: ProcDescription -> Encoding

toJSONList :: [ProcDescription] -> Value

toEncodingList :: [ProcDescription] -> Encoding

type Rep ProcDescription

Defined in PostgREST.DbStructure.Proc

type Rep ProcDescription = D1 ('MetaData "ProcDescription" "PostgREST.DbStructure.Proc" "postgrest-8.0.0-4wwkfqOKlk5GjHJ3yFP36o" 'False) (C1 ('MetaCons "ProcDescription" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pdSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Schema) :*: (S1 ('MetaSel ('Just "pdName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "pdDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "pdArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PgArg]) :*: S1 ('MetaSel ('Just "pdReturnType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RetType)) :*: (S1 ('MetaSel ('Just "pdVolatility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProcVolatility) :*: S1 ('MetaSel ('Just "pdHasVariadic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))))

data ProcVolatility

Constructors

Volatile

Stable

Immutable

Instances

Eq ProcVolatility

Defined in PostgREST.DbStructure.Proc

Methods

(==) :: ProcVolatility -> ProcVolatility -> Bool

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

Ord ProcVolatility

Defined in PostgREST.DbStructure.Proc

Methods

compare :: ProcVolatility -> ProcVolatility -> Ordering

(<) :: ProcVolatility -> ProcVolatility -> Bool

(<=) :: ProcVolatility -> ProcVolatility -> Bool

(>) :: ProcVolatility -> ProcVolatility -> Bool

(>=) :: ProcVolatility -> ProcVolatility -> Bool

max :: ProcVolatility -> ProcVolatility -> ProcVolatility

min :: ProcVolatility -> ProcVolatility -> ProcVolatility

Generic ProcVolatility

Defined in PostgREST.DbStructure.Proc

Associated Types

type Rep ProcVolatility :: Type -> Type

Methods

from :: ProcVolatility -> Rep ProcVolatility x

to :: Rep ProcVolatility x -> ProcVolatility

ToJSON ProcVolatility

Defined in PostgREST.DbStructure.Proc

Methods

toJSON :: ProcVolatility -> Value

toEncoding :: ProcVolatility -> Encoding

toJSONList :: [ProcVolatility] -> Value

toEncodingList :: [ProcVolatility] -> Encoding

type Rep ProcVolatility

Defined in PostgREST.DbStructure.Proc

type Rep ProcVolatility = D1 ('MetaData "ProcVolatility" "PostgREST.DbStructure.Proc" "postgrest-8.0.0-4wwkfqOKlk5GjHJ3yFP36o" 'False) (C1 ('MetaCons "Volatile" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Stable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Immutable" 'PrefixI 'False) (U1 :: Type -> Type)))

type ProcsMap = HashMap QualifiedIdentifier [ProcDescription]

A map of all procs, all of which can be overloaded(one entry will have more than one ProcDescription). | It uses a HashMap for a faster lookup.

data RetType

Constructors

Single PgType

SetOf PgType

Instances

Eq RetType

Defined in PostgREST.DbStructure.Proc

Methods

(==) :: RetType -> RetType -> Bool

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

Ord RetType

Defined in PostgREST.DbStructure.Proc

Methods

compare :: RetType -> RetType -> Ordering

(<) :: RetType -> RetType -> Bool

(<=) :: RetType -> RetType -> Bool

(>) :: RetType -> RetType -> Bool

(>=) :: RetType -> RetType -> Bool

max :: RetType -> RetType -> RetType

min :: RetType -> RetType -> RetType

Generic RetType

Defined in PostgREST.DbStructure.Proc

Associated Types

type Rep RetType :: Type -> Type

Methods

from :: RetType -> Rep RetType x

to :: Rep RetType x -> RetType

ToJSON RetType

Defined in PostgREST.DbStructure.Proc

Methods

toJSON :: RetType -> Value

toEncoding :: RetType -> Encoding

toJSONList :: [RetType] -> Value

toEncodingList :: [RetType] -> Encoding

type Rep RetType

Defined in PostgREST.DbStructure.Proc

type Rep RetType = D1 ('MetaData "RetType" "PostgREST.DbStructure.Proc" "postgrest-8.0.0-4wwkfqOKlk5GjHJ3yFP36o" 'False) (C1 ('MetaCons "Single" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PgType)) :+: C1 ('MetaCons "SetOf" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PgType)))

procReturnsScalar :: ProcDescription -> Bool

procReturnsSingle :: ProcDescription -> Bool

procTableName :: ProcDescription -> Maybe TableName

specifiedProcArgs :: Set FieldName -> ProcDescription -> [PgArg]

Search the procedure parameters by matching them with the specified keys. If the key doesn't match a parameter, a parameter with a default type "text" is assumed.