PostgREST.Config

Documentation

data AppConfig

Constructors

AppConfig

Fields

• configAppSettings :: [(Text, Text)]
• configDbAnonRole :: Text
• configDbChannel :: Text
• configDbChannelEnabled :: Bool
• configDbExtraSearchPath :: [Text]
• configDbMaxRows :: Maybe Integer
• configDbPoolSize :: Int
• configDbPoolTimeout :: NominalDiffTime
• configDbPreRequest :: Maybe QualifiedIdentifier
• configDbPreparedStatements :: Bool
• configDbRootSpec :: Maybe QualifiedIdentifier
• configDbSchemas :: NonEmpty Text
• configDbConfig :: Bool
• configDbTxAllowOverride :: Bool
• configDbTxRollbackAll :: Bool
• configDbUri :: Text
• configDbUseLegacyGucs :: Bool
• configFilePath :: Maybe FilePath
• configJWKS :: Maybe JWKSet
• configJwtAudience :: Maybe StringOrURI
• configJwtRoleClaimKey :: JSPath
• configJwtSecret :: Maybe ByteString
• configJwtSecretIsBase64 :: Bool
• configLogLevel :: LogLevel
• configOpenApiMode :: OpenAPIMode
• configOpenApiServerProxyUri :: Maybe Text
• configRawMediaTypes :: [ByteString]
• configServerHost :: Text
• configServerPort :: Int
• configServerUnixSocket :: Maybe FilePath
• configServerUnixSocketMode :: FileMode

type Environment = Map [Char] Text

type JSPath = [JSPathExp]

full jspath, e.g. .property[0].attr.detail

data JSPathExp

jspath expression, e.g. .property, .property[0] or ."property-dash"

Constructors

JSPKey Text

JSPIdx Int

data LogLevel

Constructors

LogCrit

LogError

LogWarn

LogInfo

data OpenAPIMode

Constructors

OAFollowPriv

OAIgnorePriv

OADisabled

Instances

Eq OpenAPIMode

Defined in PostgREST.Config

Methods

(==) :: OpenAPIMode -> OpenAPIMode -> Bool

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

data Proxy

Constructors

Proxy

Fields

• proxyScheme :: Text
• proxyHost :: Text
• proxyPort :: Integer
• proxyPath :: Text

toText :: AppConfig -> Text

Dump the config

isMalformedProxyUri :: Text -> Bool

Test whether a proxy uri is malformed or not. A valid proxy uri should be an absolute uri without query and user info, only http(s) schemes are valid, port number range is 1-65535.

For example http://postgrest.com/openapi.json https://postgrest.com:8080/openapi.json

readAppConfig :: [(Text, Text)] -> Maybe FilePath -> Maybe Text -> IO (Either Text AppConfig)

Reads and parses the config and overrides its parameters from env vars, files or db settings.

readPGRSTEnvironment :: IO Environment

Read environment variables that start with PGRST_

toURI :: Text -> URI

parseSecret :: ByteString -> JWKSet