Appwrite.Services.GraphQL (appwrite v1.0.0)

View Source

The GraphQL service allows you to query and mutate your Appwrite server using the GraphQL protocol.

You can use GraphQL to interact with any service in your Appwrite project. The endpoint accepts a JSON object containing a GraphQL query string and an optional variables map.

Summary

Functions

mutation(query)

Execute a GraphQL mutation.

query(query)

Execute a GraphQL query.

Functions

mutation(query)

@spec mutation(map()) ::
  {:ok, map()} | {:error, Appwrite.Exceptions.AppwriteException.t()}

Execute a GraphQL mutation.

Parameters

  • query (map()): The GraphQL mutation document. Must include a "query" key, and optionally "variables" and "operationName" keys.

Returns

  • {:ok, map()} containing the GraphQL response data on success.
  • {:error, AppwriteException.t()} on failure.

query(query)

@spec query(map()) ::
  {:ok, map()} | {:error, Appwrite.Exceptions.AppwriteException.t()}

Execute a GraphQL query.

Parameters

  • query (map()): The GraphQL query document. Must include a "query" key, and optionally "variables" and "operationName" keys.

Returns

  • {:ok, map()} containing the GraphQL response data on success.
  • {:error, AppwriteException.t()} on failure.