Safe Haskell	None
Language	Haskell2010

Hasura.SQL.Backend

Synopsis

data PostgresKind
- = Vanilla
- | Citus
- | Cockroach
data BackendType
- = Postgres PostgresKind
- | MSSQL
- | BigQuery
- | MySQL
- | DataConnector
data BackendSourceKind (b :: BackendType) where
- PostgresVanillaKind :: BackendSourceKind ('Postgres 'Vanilla)
- PostgresCitusKind :: BackendSourceKind ('Postgres 'Citus)
- PostgresCockroachKind :: BackendSourceKind ('Postgres 'Cockroach)
- MSSQLKind :: BackendSourceKind 'MSSQL
- BigQueryKind :: BackendSourceKind 'BigQuery
- MySQLKind :: BackendSourceKind 'MySQL
- DataConnectorKind :: DataConnectorName -> BackendSourceKind 'DataConnector
mkParseStaticBackendSourceKind :: BackendSourceKind b -> Value -> Parser (BackendSourceKind b)
mkCodecStaticBackendSourceKind :: BackendSourceKind b -> JSONCodec (BackendSourceKind b)
backendShortName :: BackendType -> Maybe Text
supportedBackends :: [BackendType]
backendTextNames :: BackendType -> [Text]
backendTextNameLookup :: [(Text, BackendType)]
backendTypeFromText :: Text -> Maybe BackendType
parseBackendTypeFromText :: Text -> Parser BackendType
backendTypeFromBackendSourceKind :: BackendSourceKind b -> BackendType

Documentation

data PostgresKind Source #

Argument to Postgres; we represent backends which are variations on Postgres as sub-types of Postgres. This value indicates which "flavour" of Postgres a backend is.

Constructors

Vanilla
Citus
Cockroach

Instances

Instances details

Eq PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend Methods (==) :: PostgresKind -> PostgresKind -> Bool # (/=) :: PostgresKind -> PostgresKind -> Bool #
Ord PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend Methods compare :: PostgresKind -> PostgresKind -> Ordering # (<) :: PostgresKind -> PostgresKind -> Bool # (<=) :: PostgresKind -> PostgresKind -> Bool # (>) :: PostgresKind -> PostgresKind -> Bool # (>=) :: PostgresKind -> PostgresKind -> Bool # max :: PostgresKind -> PostgresKind -> PostgresKind # min :: PostgresKind -> PostgresKind -> PostgresKind #
Show PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend Methods showsPrec :: Int -> PostgresKind -> ShowS # show :: PostgresKind -> String # showList :: [PostgresKind] -> ShowS #
Generic PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend Associated Types type Rep PostgresKind :: Type -> Type # Methods from :: PostgresKind -> Rep PostgresKind x # to :: Rep PostgresKind x -> PostgresKind #
Hashable PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend Methods hashWithSalt :: Int -> PostgresKind -> Int hash :: PostgresKind -> Int
Cacheable PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend Methods unchanged :: Accesses -> PostgresKind -> PostgresKind -> Bool Source #
type Rep PostgresKind Source #
Instance details Defined in Hasura.SQL.Backend type Rep PostgresKind = D1 ('MetaData "PostgresKind" "Hasura.SQL.Backend" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "Vanilla" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Citus" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cockroach" 'PrefixI 'False) (U1 :: Type -> Type)))

data BackendType Source #

An enum that represents each backend we support.

Constructors

Postgres PostgresKind
MSSQL
BigQuery
MySQL
DataConnector

Instances

Instances details

Eq BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods (==) :: BackendType -> BackendType -> Bool # (/=) :: BackendType -> BackendType -> Bool #
Ord BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods compare :: BackendType -> BackendType -> Ordering # (<) :: BackendType -> BackendType -> Bool # (<=) :: BackendType -> BackendType -> Bool # (>) :: BackendType -> BackendType -> Bool # (>=) :: BackendType -> BackendType -> Bool # max :: BackendType -> BackendType -> BackendType # min :: BackendType -> BackendType -> BackendType #
Show BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods showsPrec :: Int -> BackendType -> ShowS # show :: BackendType -> String # showList :: [BackendType] -> ShowS #
Generic BackendType Source #
Instance details Defined in Hasura.SQL.Backend Associated Types type Rep BackendType :: Type -> Type # Methods from :: BackendType -> Rep BackendType x # to :: Rep BackendType x -> BackendType #
Hashable BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods hashWithSalt :: Int -> BackendType -> Int hash :: BackendType -> Int
FromJSON BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser BackendType parseJSONList :: Value -> Parser [BackendType]
ToJSON BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods toJSON :: BackendType -> Value toEncoding :: BackendType -> Encoding toJSONList :: [BackendType] -> Value toEncodingList :: [BackendType] -> Encoding
ToTxt BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods toTxt :: BackendType -> Text Source #
Cacheable BackendType Source #
Instance details Defined in Hasura.SQL.Backend Methods unchanged :: Accesses -> BackendType -> BackendType -> Bool Source #
From BackendType NonEmptyText Source #	The name of the backend, as we expect it to appear in our metadata and API.
Instance details Defined in Hasura.SQL.Backend Methods from :: BackendType -> NonEmptyText
Cacheable (Proxy b) Source #
Instance details Defined in Hasura.SQL.Backend Methods unchanged :: Accesses -> Proxy b -> Proxy b -> Bool Source #
type Rep BackendType Source #
Instance details Defined in Hasura.SQL.Backend type Rep BackendType = D1 ('MetaData "BackendType" "Hasura.SQL.Backend" "graphql-engine-1.0.0-inplace" 'False) ((C1 ('MetaCons "Postgres" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PostgresKind)) :+: C1 ('MetaCons "MSSQL" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "BigQuery" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "MySQL" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DataConnector" 'PrefixI 'False) (U1 :: Type -> Type))))

data BackendSourceKind (b :: BackendType) where Source #

Similar to BackendType, however, in the case of DataConnectorKind we need to be able capture the name of the data connector that should be used by the DataConnector backend. This type correlates to the kind property of SourceMetadata, which is usually just postgres, mssql, etc for static backends, but can be a configurable value for DataConnector hence requiring DataConnectorName for DataConnectorKind

This type cannot entirely replace BackendType because BackendType has a fixed number of possible values which can be enumerated over at compile time, but BackendSourceKind does not because DataConnector fundamentally is configured at runtime with DataConnectorName.

Instances

Instances details

Eq (BackendSourceKind b) Source #
Instance details Defined in Hasura.SQL.Backend Methods (==) :: BackendSourceKind b -> BackendSourceKind b -> Bool # (/=) :: BackendSourceKind b -> BackendSourceKind b -> Bool #
Ord (BackendSourceKind b) Source #
Instance details Defined in Hasura.SQL.Backend Methods compare :: BackendSourceKind b -> BackendSourceKind b -> Ordering # (<) :: BackendSourceKind b -> BackendSourceKind b -> Bool # (<=) :: BackendSourceKind b -> BackendSourceKind b -> Bool # (>) :: BackendSourceKind b -> BackendSourceKind b -> Bool # (>=) :: BackendSourceKind b -> BackendSourceKind b -> Bool # max :: BackendSourceKind b -> BackendSourceKind b -> BackendSourceKind b # min :: BackendSourceKind b -> BackendSourceKind b -> BackendSourceKind b #
Show (BackendSourceKind b) Source #
Instance details Defined in Hasura.SQL.Backend Methods showsPrec :: Int -> BackendSourceKind b -> ShowS # show :: BackendSourceKind b -> String # showList :: [BackendSourceKind b] -> ShowS #
HasCodec (BackendSourceKind ('Postgres 'Vanilla)) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind ('Postgres 'Vanilla)) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind ('Postgres 'Vanilla)]
HasCodec (BackendSourceKind ('Postgres 'Citus)) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind ('Postgres 'Citus)) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind ('Postgres 'Citus)]
HasCodec (BackendSourceKind ('Postgres 'Cockroach)) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind ('Postgres 'Cockroach)) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind ('Postgres 'Cockroach)]
HasCodec (BackendSourceKind 'MSSQL) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind 'MSSQL) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind 'MSSQL]
HasCodec (BackendSourceKind 'BigQuery) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind 'BigQuery) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind 'BigQuery]
HasCodec (BackendSourceKind 'MySQL) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind 'MySQL) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind 'MySQL]
HasCodec (BackendSourceKind 'DataConnector) Source #
Instance details Defined in Hasura.SQL.Backend Methods codec :: JSONCodec (BackendSourceKind 'DataConnector) listCodecForStringCompatibility :: JSONCodec [BackendSourceKind 'DataConnector]
FromJSON (BackendSourceKind ('Postgres 'Vanilla)) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind ('Postgres 'Vanilla)) parseJSONList :: Value -> Parser [BackendSourceKind ('Postgres 'Vanilla)]
FromJSON (BackendSourceKind ('Postgres 'Citus)) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind ('Postgres 'Citus)) parseJSONList :: Value -> Parser [BackendSourceKind ('Postgres 'Citus)]
FromJSON (BackendSourceKind ('Postgres 'Cockroach)) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind ('Postgres 'Cockroach)) parseJSONList :: Value -> Parser [BackendSourceKind ('Postgres 'Cockroach)]
FromJSON (BackendSourceKind 'MSSQL) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind 'MSSQL) parseJSONList :: Value -> Parser [BackendSourceKind 'MSSQL]
FromJSON (BackendSourceKind 'BigQuery) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind 'BigQuery) parseJSONList :: Value -> Parser [BackendSourceKind 'BigQuery]
FromJSON (BackendSourceKind 'MySQL) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind 'MySQL) parseJSONList :: Value -> Parser [BackendSourceKind 'MySQL]
FromJSON (BackendSourceKind 'DataConnector) Source #
Instance details Defined in Hasura.SQL.Backend Methods parseJSON :: Value -> Parser (BackendSourceKind 'DataConnector) parseJSONList :: Value -> Parser [BackendSourceKind 'DataConnector]
ToJSON (BackendSourceKind b) Source #
Instance details Defined in Hasura.SQL.Backend Methods toJSON :: BackendSourceKind b -> Value toEncoding :: BackendSourceKind b -> Encoding toJSONList :: [BackendSourceKind b] -> Value toEncodingList :: [BackendSourceKind b] -> Encoding
ToTxt (BackendSourceKind b) Source #
Instance details Defined in Hasura.SQL.Backend Methods toTxt :: BackendSourceKind b -> Text Source #
Cacheable (BackendSourceKind b) Source #
Instance details Defined in Hasura.SQL.Backend Methods unchanged :: Accesses -> BackendSourceKind b -> BackendSourceKind b -> Bool Source #
From (BackendSourceKind b) NonEmptyText Source #
Instance details Defined in Hasura.SQL.Backend Methods from :: BackendSourceKind b -> NonEmptyText
Backend b => FromJSONWithContext (BackendSourceKind b) (SourceMetadata b) Source #
Instance details Defined in Hasura.RQL.Types.Metadata.Common Methods parseJSONWithContext :: BackendSourceKind b -> Value -> Parser (SourceMetadata b) Source #
Backend b => FromJSONWithContext (BackendSourceKind b) (AddSource b) Source #
Instance details Defined in Hasura.RQL.DDL.Schema.Source Methods parseJSONWithContext :: BackendSourceKind b -> Value -> Parser (AddSource b) Source #
Backend b => FromJSONWithContext (BackendSourceKind b) (UpdateSource b) Source #
Instance details Defined in Hasura.RQL.DDL.Schema.Source Methods parseJSONWithContext :: BackendSourceKind b -> Value -> Parser (UpdateSource b) Source #

mkParseStaticBackendSourceKind :: BackendSourceKind b -> Value -> Parser (BackendSourceKind b) Source #

mkCodecStaticBackendSourceKind :: BackendSourceKind b -> JSONCodec (BackendSourceKind b) Source #

backendShortName :: BackendType -> Maybe Text Source #

Some generated APIs use a shortened version of the backend's name rather than its full name. This function returns the "short form" of a backend, if any.

supportedBackends :: [BackendType] Source #

backendTextNames :: BackendType -> [Text] Source #

backendTextNameLookup :: [(Text, BackendType)] Source #

backendTypeFromText :: Text -> Maybe BackendType Source #

This uses this lookup mechanism to avoid having to duplicate and hardcode the backend string. We accept both the short form and the long form of the backend's name.

parseBackendTypeFromText :: Text -> Parser BackendType Source #

backendTypeFromBackendSourceKind :: BackendSourceKind b -> BackendType Source #

PostgresVanillaKind :: BackendSourceKind ('Postgres 'Vanilla)
PostgresCitusKind :: BackendSourceKind ('Postgres 'Citus)
PostgresCockroachKind :: BackendSourceKind ('Postgres 'Cockroach)
MSSQLKind :: BackendSourceKind 'MSSQL
BigQueryKind :: BackendSourceKind 'BigQuery
MySQLKind :: BackendSourceKind 'MySQL
DataConnectorKind :: DataConnectorName -> BackendSourceKind 'DataConnector