mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-18 04:51:35 +03:00
f6fd9f071d
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9002 GitOrigin-RevId: 2e2a499f5035adf1493a2d675ee52abb7c87a8c8
105 lines
3.7 KiB
Haskell
105 lines
3.7 KiB
Haskell
{-# LANGUAGE DeriveAnyClass #-}
|
|
{-# LANGUAGE TemplateHaskell #-}
|
|
{-# LANGUAGE UndecidableInstances #-}
|
|
|
|
-- | Metadata representation of a native query in the metadata,
|
|
-- as well as a parser and prettyprinter for the query code.
|
|
module Hasura.NativeQuery.Metadata
|
|
( NativeQueryName (..),
|
|
NativeQueryMetadata (..),
|
|
nqmArguments,
|
|
nqmCode,
|
|
nqmDescription,
|
|
nqmReturns,
|
|
nqmArrayRelationships,
|
|
nqmRootFieldName,
|
|
NativeQueryArgumentName (..),
|
|
InterpolatedItem (..),
|
|
InterpolatedQuery (..),
|
|
parseInterpolatedQuery,
|
|
module Hasura.NativeQuery.Types,
|
|
)
|
|
where
|
|
|
|
import Autodocodec
|
|
import Autodocodec qualified as AC
|
|
import Control.Lens (makeLenses)
|
|
import Data.Aeson (FromJSON, ToJSON)
|
|
import Data.HashMap.Strict.InsOrd.Autodocodec (sortedElemsCodec)
|
|
import Data.Text.Extended qualified as T
|
|
import Hasura.LogicalModel.Types
|
|
import Hasura.NativeQuery.InterpolatedQuery
|
|
import Hasura.NativeQuery.Types (NativeQueryName (..), NullableScalarType (..), nullableScalarTypeMapCodec)
|
|
import Hasura.Prelude hiding (first)
|
|
import Hasura.RQL.Types.Backend
|
|
import Hasura.RQL.Types.BackendTag (backendPrefix)
|
|
import Hasura.RQL.Types.BackendType
|
|
import Hasura.RQL.Types.Common (RelName)
|
|
import Hasura.RQL.Types.Relationships.Local (RelDef (..), RelManualConfig (..))
|
|
|
|
-- | copy pasta'd from Hasura.RQL.Types.Metadata.Common, forgive me Padre i did
|
|
-- not have the heart for the Real Fix.
|
|
type Relationships = InsOrdHashMap RelName
|
|
|
|
---------------------------------------
|
|
|
|
-- | The representation of native queries within the metadata structure.
|
|
data NativeQueryMetadata (b :: BackendType) = NativeQueryMetadata
|
|
{ _nqmRootFieldName :: NativeQueryName,
|
|
_nqmCode :: InterpolatedQuery NativeQueryArgumentName,
|
|
_nqmReturns :: LogicalModelName,
|
|
_nqmArguments :: HashMap NativeQueryArgumentName (NullableScalarType b),
|
|
_nqmArrayRelationships :: Relationships (RelDef (RelManualConfig b)),
|
|
_nqmDescription :: Maybe Text
|
|
}
|
|
deriving (Generic)
|
|
|
|
deriving instance Backend b => Eq (NativeQueryMetadata b)
|
|
|
|
deriving instance Backend b => Show (NativeQueryMetadata b)
|
|
|
|
instance (Backend b) => HasCodec (NativeQueryMetadata b) where
|
|
codec =
|
|
CommentCodec
|
|
("A native query as represented in metadata.")
|
|
$ AC.object (backendPrefix @b <> "NativeQueryMetadata")
|
|
$ NativeQueryMetadata
|
|
<$> requiredField "root_field_name" fieldNameDoc
|
|
AC..= _nqmRootFieldName
|
|
<*> requiredField "code" sqlDoc
|
|
AC..= _nqmCode
|
|
<*> requiredField "returns" returnsDoc
|
|
AC..= _nqmReturns
|
|
<*> optionalFieldWithDefault "arguments" mempty argumentDoc
|
|
AC..= _nqmArguments
|
|
<*> optSortedList "array_relationships" _rdName
|
|
AC..= _nqmArrayRelationships
|
|
<*> optionalField "description" descriptionDoc
|
|
AC..= _nqmDescription
|
|
where
|
|
fieldNameDoc = "Root field name for the native query"
|
|
sqlDoc = "Native code expression (SQL) to run"
|
|
argumentDoc = "Free variables in the expression and their types"
|
|
returnsDoc = "Return type (table) of the expression"
|
|
descriptionDoc = "A description of the native query which appears in the graphql schema"
|
|
|
|
optSortedList ::
|
|
(HasCodec a, Eq a, Hashable k, Ord k, T.ToTxt k) =>
|
|
Text ->
|
|
(a -> k) ->
|
|
ObjectCodec (InsOrdHashMap k a) (InsOrdHashMap k a)
|
|
optSortedList name keyForElem =
|
|
AC.optionalFieldWithOmittedDefaultWith' name (sortedElemsCodec keyForElem) mempty
|
|
|
|
deriving via
|
|
(Autodocodec (NativeQueryMetadata b))
|
|
instance
|
|
(Backend b) => (FromJSON (NativeQueryMetadata b))
|
|
|
|
deriving via
|
|
(Autodocodec (NativeQueryMetadata b))
|
|
instance
|
|
(Backend b) => (ToJSON (NativeQueryMetadata b))
|
|
|
|
makeLenses ''NativeQueryMetadata
|