GraphQL reference

GraphQL reference

This section provides reference information for the Fauna GraphQL API.

You can find step-by-step GraphQL tutorials in the Tutorials section.

See Limits for details on document size and transaction limits.

Overview

GraphQL is an industry-standard API specification language which describes a data interface and is independent of the underlying system which manages the data. It provides a helpful layer of abstraction between a Fauna database and a data consumer such as an application. GraphQL itself knows nothing about Fauna’s implementation, such as collections, indexes, or query language.

Resources

For more general information about GraphQL, training, or the specification itself, see these resources:

There are a few online, interactive GraphQL interfaces. The one we recommend is GraphQL Playground. It is embedded into the Fauna Dashboard.

For developers, the Fauna GraphQL API should work with most GraphQL libraries. See the next section for known limitations.

Limitations

The Fauna GraphQL API is in its initial release. It is functional, and can handle most GraphQL workloads. However, there are some GraphQL features that are currently not supported:

  • Schemas do not support:

    • Custom directives

    • Custom interfaces

    • Custom scalars

    • Union types

  • No name can start with an underscore (_)

  • Subscriptions are not supported.

Also, Fauna GraphQL API can only work with the defined schema. Any existing collections, indexes, or functions that may exist in a database, that are not referenced in the GraphQL schema, are unavailable to GraphQL queries.

Was this article helpful? 

We're sorry to hear that.
Tell us how we can improve!
Visit Fauna's forums or email docs@fauna.com

Thank you for your feedback!