mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-16 18:42:30 +03:00
4c8ea8e865
Result of executing the following commands:
```shell
# replace "as Q" imports with "as PG" (in retrospect this didn't need a regex)
git grep -lE 'as Q($|[^a-zA-Z])' -- '*.hs' | xargs sed -i -E 's/as Q($|[^a-zA-Z])/as PG\1/'
# replace " Q." with " PG."
git grep -lE ' Q\.' -- '*.hs' | xargs sed -i 's/ Q\./ PG./g'
# replace "(Q." with "(PG."
git grep -lE '\(Q\.' -- '*.hs' | xargs sed -i 's/(Q\./(PG./g'
# ditto, but for [, |, { and !
git grep -lE '\[Q\.' -- '*.hs' | xargs sed -i 's/\[Q\./\[PG./g'
git grep -l '|Q\.' -- '*.hs' | xargs sed -i 's/|Q\./|PG./g'
git grep -l '{Q\.' -- '*.hs' | xargs sed -i 's/{Q\./{PG./g'
git grep -l '!Q\.' -- '*.hs' | xargs sed -i 's/!Q\./!PG./g'
```
(Doing the `grep -l` before the `sed`, instead of `sed` on the entire codebase, reduces the number of `mtime` updates, and so reduces how many times a file gets recompiled while checking intermediate results.)
Finally, I manually removed a broken and unused `Arbitrary` instance in `Hasura.RQL.Network`. (It used an `import Test.QuickCheck.Arbitrary as Q` statement, which was erroneously caught by the first find-replace command.)
After this PR, `Q` is no longer used as an import qualifier. That was not the goal of this PR, but perhaps it's a useful fact for future efforts.
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/5933
GitOrigin-RevId: 8c84c59d57789111d40f5d3322c5a885dcfbf40e
74 lines
3.0 KiB
Haskell
74 lines
3.0 KiB
Haskell
{-# LANGUAGE TemplateHaskell #-}
|
|
|
|
-- | This module (along with the various @Hasura.RQL.DDL.Schema.*@ modules) provides operations to
|
|
-- load and modify the Hasura catalog and schema cache.
|
|
--
|
|
-- * The /catalog/ refers to the set of PostgreSQL tables and views that store all schema information
|
|
-- known by Hasura. This includes any tracked Postgres tables, views, and functions, all remote
|
|
-- schemas, and any additionaly Hasura-specific information such as permissions and relationships.
|
|
--
|
|
-- Primitive functions for loading and modifying the catalog are defined in
|
|
-- "Hasura.RQL.DDL.Schema.Catalog", but most uses are wrapped by other functions to synchronize
|
|
-- catalog information with the information in the schema cache.
|
|
--
|
|
-- * The /schema cache/ is a process-global value of type 'SchemaCache' that stores an in-memory
|
|
-- representation of the data stored in the catalog. The in-memory representation is not identical
|
|
-- to the data in the catalog, since it has some post-processing applied to it in order to make it
|
|
-- easier to consume for other parts of the system, such as GraphQL schema generation. For example,
|
|
-- although column information is represented by 'RawColumnInfo', the schema cache contains
|
|
-- “processed” 'ColumnInfo' values, instead.
|
|
--
|
|
-- Ultimately, the catalog is the source of truth for all information contained in the schema
|
|
-- cache, but to avoid rebuilding the entire schema cache on every change to the catalog, various
|
|
-- functions incrementally update the cache when they modify the catalog.
|
|
module Hasura.RQL.DDL.Schema
|
|
( module M,
|
|
RunSQLRes (..),
|
|
)
|
|
where
|
|
|
|
import Data.Aeson
|
|
import Data.Aeson.TH (deriveJSON)
|
|
import Data.Text.Encoding qualified as TE
|
|
import Database.PG.Query qualified as PG
|
|
import Database.PostgreSQL.LibPQ qualified as PQ
|
|
import Hasura.Prelude
|
|
import Hasura.RQL.DDL.Schema.Cache as M
|
|
import Hasura.RQL.DDL.Schema.Catalog as M
|
|
import Hasura.RQL.DDL.Schema.Function as M
|
|
import Hasura.RQL.DDL.Schema.Rename as M
|
|
import Hasura.RQL.DDL.Schema.Table as M
|
|
|
|
data RunSQLRes = RunSQLRes
|
|
{ rrResultType :: Text,
|
|
rrResult :: Value
|
|
}
|
|
deriving (Show, Eq)
|
|
|
|
$(deriveJSON hasuraJSON ''RunSQLRes)
|
|
|
|
instance PG.FromRes RunSQLRes where
|
|
fromRes (PG.ResultOkEmpty _) =
|
|
return $ RunSQLRes "CommandOk" Null
|
|
fromRes (PG.ResultOkData res) = do
|
|
csvRows <- resToCSV res
|
|
return $ RunSQLRes "TuplesOk" $ toJSON csvRows
|
|
where
|
|
resToCSV :: PQ.Result -> ExceptT Text IO [[Text]]
|
|
resToCSV r = do
|
|
nr <- liftIO $ PQ.ntuples r
|
|
nc <- liftIO $ PQ.nfields r
|
|
|
|
hdr <- forM [0 .. pred nc] $ \ic -> do
|
|
colNameBS <- liftIO $ PQ.fname r ic
|
|
maybe (return "unknown") decodeBS colNameBS
|
|
|
|
rows <- forM [0 .. pred nr] $ \ir ->
|
|
forM [0 .. pred nc] $ \ic -> do
|
|
cellValBS <- liftIO $ PQ.getvalue r ir ic
|
|
maybe (return "NULL") decodeBS cellValBS
|
|
|
|
return $ hdr : rows
|
|
|
|
decodeBS = either (throwError . tshow) return . TE.decodeUtf8'
|