Safe Haskell	None
Language	Haskell2010

Hasura.RQL.Types.Relationships.ToSchema

Synopsis

data ToSchemaRelationshipDef = ToSchemaRelationshipDef {
- _trrdRemoteSchema :: RemoteSchemaName
- _trrdLhsFields :: HashSet FieldName
- _trrdRemoteField :: RemoteFields
}
newtype RemoteFields = RemoteFields {
- unRemoteFields :: NonEmpty FieldCall
}
data FieldCall = FieldCall {
- fcName :: Name
- fcArguments :: RemoteArguments
}
newtype RemoteArguments = RemoteArguments {
- getRemoteArguments :: HashMap Name (Value Name)
}
newtype LHSIdentifier = LHSIdentifier {
- getLHSIdentifier :: Text
}
tableNameToLHSIdentifier :: Backend b => TableName b -> LHSIdentifier
remoteSchemaToLHSIdentifier :: RemoteSchemaName -> LHSIdentifier
lhsIdentifierToGraphQLName :: LHSIdentifier -> Maybe Name
data RemoteSchemaFieldInfo = RemoteSchemaFieldInfo {
- _rrfiName :: RelName
- _rrfiParamMap :: HashMap Name RemoteSchemaInputValueDefinition
- _rrfiRemoteFields :: RemoteFields
- _rrfiRemoteSchema :: RemoteSchemaInfo
- _rrfiInputValueDefinitions :: [TypeDefinition [Name] RemoteSchemaInputValueDefinition]
- _rrfiRemoteSchemaName :: RemoteSchemaName
- _rrfiLHSIdentifier :: LHSIdentifier
}
graphQLValueToJSON :: Value Void -> Value
trrdRemoteSchema :: Lens' ToSchemaRelationshipDef RemoteSchemaName
trrdRemoteField :: Lens' ToSchemaRelationshipDef RemoteFields
trrdLhsFields :: Lens' ToSchemaRelationshipDef (HashSet FieldName)

Documentation

data ToSchemaRelationshipDef Source #

Metadata representation of a relationship to a remote schema.

FIXME: move this to Hasura/Metadata

Constructors

ToSchemaRelationshipDef
Fields _trrdRemoteSchema :: RemoteSchemaName Identifier for this mapping. _trrdLhsFields :: HashSet FieldName The lhs fields that must be forwarded to the remote schema. _trrdRemoteField :: RemoteFields

Instances

Instances details

Eq ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods (==) :: ToSchemaRelationshipDef -> ToSchemaRelationshipDef -> Bool # (/=) :: ToSchemaRelationshipDef -> ToSchemaRelationshipDef -> Bool #
Show ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods showsPrec :: Int -> ToSchemaRelationshipDef -> ShowS # show :: ToSchemaRelationshipDef -> String # showList :: [ToSchemaRelationshipDef] -> ShowS #
Generic ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Associated Types type Rep ToSchemaRelationshipDef :: Type -> Type # Methods from :: ToSchemaRelationshipDef -> Rep ToSchemaRelationshipDef x # to :: Rep ToSchemaRelationshipDef x -> ToSchemaRelationshipDef #
NFData ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods rnf :: ToSchemaRelationshipDef -> () #
FromJSON ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods parseJSON :: Value -> Parser ToSchemaRelationshipDef parseJSONList :: Value -> Parser [ToSchemaRelationshipDef]
ToJSON ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods toJSON :: ToSchemaRelationshipDef -> Value toEncoding :: ToSchemaRelationshipDef -> Encoding toJSONList :: [ToSchemaRelationshipDef] -> Value toEncodingList :: [ToSchemaRelationshipDef] -> Encoding
Cacheable ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods unchanged :: Accesses -> ToSchemaRelationshipDef -> ToSchemaRelationshipDef -> Bool Source #
type Rep ToSchemaRelationshipDef Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema type Rep ToSchemaRelationshipDef = D1 ('MetaData "ToSchemaRelationshipDef" "Hasura.RQL.Types.Relationships.ToSchema" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "ToSchemaRelationshipDef" 'PrefixI 'True) (S1 ('MetaSel ('Just "_trrdRemoteSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemoteSchemaName) :: (S1 ('MetaSel ('Just "_trrdLhsFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashSet FieldName)) :: S1 ('MetaSel ('Just "_trrdRemoteField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemoteFields))))

newtype RemoteFields Source #

Targeted field in a remote schema relationship. TODO: explain about subfields and why this is a container

Constructors

RemoteFields
Fields unRemoteFields :: NonEmpty FieldCall

Instances

Instances details

Eq RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods (==) :: RemoteFields -> RemoteFields -> Bool # (/=) :: RemoteFields -> RemoteFields -> Bool #
Show RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods showsPrec :: Int -> RemoteFields -> ShowS # show :: RemoteFields -> String # showList :: [RemoteFields] -> ShowS #
Generic RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Associated Types type Rep RemoteFields :: Type -> Type # Methods from :: RemoteFields -> Rep RemoteFields x # to :: Rep RemoteFields x -> RemoteFields #
NFData RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods rnf :: RemoteFields -> () #
FromJSON RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods parseJSON :: Value -> Parser RemoteFields parseJSONList :: Value -> Parser [RemoteFields]
ToJSON RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods toJSON :: RemoteFields -> Value toEncoding :: RemoteFields -> Encoding toJSONList :: [RemoteFields] -> Value toEncodingList :: [RemoteFields] -> Encoding
Cacheable RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods unchanged :: Accesses -> RemoteFields -> RemoteFields -> Bool Source #
type Rep RemoteFields Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema type Rep RemoteFields = D1 ('MetaData "RemoteFields" "Hasura.RQL.Types.Relationships.ToSchema" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "RemoteFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "unRemoteFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty FieldCall))))

data FieldCall Source #

Associates a field name with the arguments it will be passed in the query.

https://graphql.github.io/graphql-spec/June2018/#sec-Language.Arguments

Constructors

FieldCall
Fields fcName :: Name fcArguments :: RemoteArguments

Instances

Instances details

Eq FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods (==) :: FieldCall -> FieldCall -> Bool # (/=) :: FieldCall -> FieldCall -> Bool #
Show FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods showsPrec :: Int -> FieldCall -> ShowS # show :: FieldCall -> String # showList :: [FieldCall] -> ShowS #
Generic FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Associated Types type Rep FieldCall :: Type -> Type # Methods from :: FieldCall -> Rep FieldCall x # to :: Rep FieldCall x -> FieldCall #
NFData FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods rnf :: FieldCall -> () #
Hashable FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods hashWithSalt :: Int -> FieldCall -> Int hash :: FieldCall -> Int
Cacheable FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods unchanged :: Accesses -> FieldCall -> FieldCall -> Bool Source #
type Rep FieldCall Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema type Rep FieldCall = D1 ('MetaData "FieldCall" "Hasura.RQL.Types.Relationships.ToSchema" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "FieldCall" 'PrefixI 'True) (S1 ('MetaSel ('Just "fcName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Name) :*: S1 ('MetaSel ('Just "fcArguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemoteArguments)))

newtype RemoteArguments Source #

Arguments to a remote GraphQL fields, represented as a mapping from name to GraphQL Value. Said values can be variable names, in which case they'll be referring to values we're closed over. TODO: expand on this

Constructors

RemoteArguments
Fields getRemoteArguments :: HashMap Name (Value Name)

Instances

Instances details

Eq RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods (==) :: RemoteArguments -> RemoteArguments -> Bool # (/=) :: RemoteArguments -> RemoteArguments -> Bool #
Show RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods showsPrec :: Int -> RemoteArguments -> ShowS # show :: RemoteArguments -> String # showList :: [RemoteArguments] -> ShowS #
Generic RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Associated Types type Rep RemoteArguments :: Type -> Type # Methods from :: RemoteArguments -> Rep RemoteArguments x # to :: Rep RemoteArguments x -> RemoteArguments #
NFData RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods rnf :: RemoteArguments -> () #
Hashable RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods hashWithSalt :: Int -> RemoteArguments -> Int hash :: RemoteArguments -> Int
FromJSON RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods parseJSON :: Value -> Parser RemoteArguments parseJSONList :: Value -> Parser [RemoteArguments]
ToJSON RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods toJSON :: RemoteArguments -> Value toEncoding :: RemoteArguments -> Encoding toJSONList :: [RemoteArguments] -> Value toEncodingList :: [RemoteArguments] -> Encoding
Cacheable RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods unchanged :: Accesses -> RemoteArguments -> RemoteArguments -> Bool Source #
type Rep RemoteArguments Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema type Rep RemoteArguments = D1 ('MetaData "RemoteArguments" "Hasura.RQL.Types.Relationships.ToSchema" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "RemoteArguments" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRemoteArguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap Name (Value Name)))))

newtype LHSIdentifier Source #

Constructors

LHSIdentifier
Fields getLHSIdentifier :: Text

Instances

Instances details

Eq LHSIdentifier Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods (==) :: LHSIdentifier -> LHSIdentifier -> Bool # (/=) :: LHSIdentifier -> LHSIdentifier -> Bool #
Show LHSIdentifier Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods showsPrec :: Int -> LHSIdentifier -> ShowS # show :: LHSIdentifier -> String # showList :: [LHSIdentifier] -> ShowS #
Generic LHSIdentifier Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Associated Types type Rep LHSIdentifier :: Type -> Type # Methods from :: LHSIdentifier -> Rep LHSIdentifier x # to :: Rep LHSIdentifier x -> LHSIdentifier #
Cacheable LHSIdentifier Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods unchanged :: Accesses -> LHSIdentifier -> LHSIdentifier -> Bool Source #
type Rep LHSIdentifier Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema type Rep LHSIdentifier = D1 ('MetaData "LHSIdentifier" "Hasura.RQL.Types.Relationships.ToSchema" "graphql-engine-1.0.0-inplace" 'True) (C1 ('MetaCons "LHSIdentifier" 'PrefixI 'True) (S1 ('MetaSel ('Just "getLHSIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

tableNameToLHSIdentifier :: Backend b => TableName b -> LHSIdentifier Source #

remoteSchemaToLHSIdentifier :: RemoteSchemaName -> LHSIdentifier Source #

lhsIdentifierToGraphQLName :: LHSIdentifier -> Maybe Name Source #

Generates a valid graphql name from an arbitrary LHS identifier. This is done by replacing all unrecognized characters by '_'. This function still returns a Maybe value, in cases we can't adjust the raw text (such as the case of empty identifiers).

data RemoteSchemaFieldInfo Source #

Schema cache information for a table field targeting a remote schema.

Constructors

RemoteSchemaFieldInfo

Fields

_rrfiName :: RelName
Field name to which we'll map the remote in hasura; this becomes part of the hasura schema.
_rrfiParamMap :: HashMap Name RemoteSchemaInputValueDefinition
Input arguments to the remote field info; The _rfiParamMap will only include the arguments to the remote field that is being joined. The names of the arguments here are modified, it will be in the format of Field Name_remote_rel_table schema_table name relationship name
_rrfiRemoteFields :: RemoteFields
_rrfiRemoteSchema :: RemoteSchemaInfo
_rrfiInputValueDefinitions :: [TypeDefinition [Name] RemoteSchemaInputValueDefinition]
The new input value definitions created for this remote field
_rrfiRemoteSchemaName :: RemoteSchemaName
Name of the remote schema, that's used for joining
_rrfiLHSIdentifier :: LHSIdentifier
TODO: this one should be gone when validateRemoteRelationship function is cleaned up

Instances

Instances details

Eq RemoteSchemaFieldInfo Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods (==) :: RemoteSchemaFieldInfo -> RemoteSchemaFieldInfo -> Bool # (/=) :: RemoteSchemaFieldInfo -> RemoteSchemaFieldInfo -> Bool #
Show RemoteSchemaFieldInfo Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods showsPrec :: Int -> RemoteSchemaFieldInfo -> ShowS # show :: RemoteSchemaFieldInfo -> String # showList :: [RemoteSchemaFieldInfo] -> ShowS #
Generic RemoteSchemaFieldInfo Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Associated Types type Rep RemoteSchemaFieldInfo :: Type -> Type # Methods from :: RemoteSchemaFieldInfo -> Rep RemoteSchemaFieldInfo x # to :: Rep RemoteSchemaFieldInfo x -> RemoteSchemaFieldInfo #
ToJSON RemoteSchemaFieldInfo Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods toJSON :: RemoteSchemaFieldInfo -> Value toEncoding :: RemoteSchemaFieldInfo -> Encoding toJSONList :: [RemoteSchemaFieldInfo] -> Value toEncodingList :: [RemoteSchemaFieldInfo] -> Encoding
Cacheable RemoteSchemaFieldInfo Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema Methods unchanged :: Accesses -> RemoteSchemaFieldInfo -> RemoteSchemaFieldInfo -> Bool Source #
type Rep RemoteSchemaFieldInfo Source #
Instance details Defined in Hasura.RQL.Types.Relationships.ToSchema type Rep RemoteSchemaFieldInfo = D1 ('MetaData "RemoteSchemaFieldInfo" "Hasura.RQL.Types.Relationships.ToSchema" "graphql-engine-1.0.0-inplace" 'False) (C1 ('MetaCons "RemoteSchemaFieldInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_rrfiName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RelName) :: (S1 ('MetaSel ('Just "_rrfiParamMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Name RemoteSchemaInputValueDefinition)) :: S1 ('MetaSel ('Just "_rrfiRemoteFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemoteFields))) :: ((S1 ('MetaSel ('Just "_rrfiRemoteSchema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemoteSchemaInfo) :: S1 ('MetaSel ('Just "_rrfiInputValueDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TypeDefinition [Name] RemoteSchemaInputValueDefinition])) :: (S1 ('MetaSel ('Just "_rrfiRemoteSchemaName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemoteSchemaName) :: S1 ('MetaSel ('Just "_rrfiLHSIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LHSIdentifier)))))

graphQLValueToJSON :: Value Void -> Value Source #

trrdRemoteSchema :: Lens' ToSchemaRelationshipDef RemoteSchemaName Source #

trrdRemoteField :: Lens' ToSchemaRelationshipDef RemoteFields Source #

trrdLhsFields :: Lens' ToSchemaRelationshipDef (HashSet FieldName) Source #