hiku.readers.graphql

Support for queries encoded using GraphQL syntax.

class hiku.readers.graphql.Operation(type_: OperationType, query: Node, name: str | None = None)

Represents requested GraphQL operation

type

type of the operation

query

operation’s query

name

optional name of the operation

class hiku.readers.graphql.OperationType(value)

Enumerates GraphQL operation types

QUERY = OperationType.QUERY

query operation

MUTATION = OperationType.MUTATION

mutation operation

SUBSCRIPTION = OperationType.SUBSCRIPTION

subscription operation

hiku.readers.graphql.read(src: str, variables: Dict | None = None, operation_name: str | None = None) → Node

Reads a query from the GraphQL document

Example:

query = read('{ foo bar }')
result = engine.execute(graph, query)

Parameters:

• src (str) – GraphQL query

• variables (dict) – query variables

• operation_name (str) – Name of the operation to execute

Returns:

hiku.query.Node, ready to execute query object

hiku.readers.graphql.read_operation(src: str | DocumentNode, variables: Dict | ImmutableDict | None = None, operation_name: str | None = None) → Operation

Reads an operation from the GraphQL document

Example:

op = read_operation('{ foo bar }')
if op.type is OperationType.QUERY:
    result = engine.execute(op.query, query_graph)

Returns:

Operation