graphql-engine-1.0.0: GraphQL API over Postgres
Safe HaskellSafe-Inferred
LanguageHaskell2010

Hasura.Backends.Postgres.DDL.RunSQL

Description

Postgres DDL RunSQL

Escape hatch for running raw SQL against a postgres database.

runRunSQL executes the provided raw SQL.

isSchemaCacheBuildRequiredRunSQL checks for known schema-mutating keywords in the raw SQL text.

See V2Query and Query.

Synopsis

Documentation

data RunSQL Source #

Constructors

RunSQL 

Fields

Instances

Instances details
FromJSON RunSQL Source # 
Instance details

Defined in Hasura.Backends.Postgres.DDL.RunSQL

Methods

parseJSON :: Value -> Parser RunSQL Source #

parseJSONList :: Value -> Parser [RunSQL] Source #

ToJSON RunSQL Source # 
Instance details

Defined in Hasura.Backends.Postgres.DDL.RunSQL

Methods

toJSON :: RunSQL -> Value Source #

toEncoding :: RunSQL -> Encoding Source #

toJSONList :: [RunSQL] -> Value Source #

toEncodingList :: [RunSQL] -> Encoding Source #

Show RunSQL Source # 
Instance details

Defined in Hasura.Backends.Postgres.DDL.RunSQL

Methods

showsPrec :: Int -> RunSQL -> ShowS #

show :: RunSQL -> String #

showList :: [RunSQL] -> ShowS #

Eq RunSQL Source # 
Instance details

Defined in Hasura.Backends.Postgres.DDL.RunSQL

Methods

(==) :: RunSQL -> RunSQL -> Bool #

(/=) :: RunSQL -> RunSQL -> Bool #

isSchemaCacheBuildRequiredRunSQL :: RunSQL -> Bool Source #

Check for known schema-mutating keywords in the raw SQL text.

See Note [Checking metadata consistency in run_sql].

isReadOnly :: RunSQL -> Bool Source #

runRunSQL :: forall (pgKind :: PostgresKind) m. (BackendMetadata ('Postgres pgKind), ToMetadataFetchQuery pgKind, FetchTableMetadata pgKind, FetchFunctionMetadata pgKind, CacheRWM m, MetadataM m, MonadBaseControl IO m, MonadError QErr m, MonadIO m, MonadTrace m, UserInfoM m) => SQLGenCtx -> RunSQL -> m EncJSON Source #

Used as an escape hatch to run raw SQL against a database.