graphql.rst

GraphQL

The GraphQL API is implemented with Ariadne. See https://ariadnegraphql.org/docs/intro for documentation.

The backend.graphql package is laid out as follows:

graphql/
├── __init__.py          # Exports the final `schema`.
├── enums.py             # Contains the GraphQL enum resolvers.
├── mutation.py          # Contains the base `mutation` type.
├── query.py             # Contains the base `query` type.
├── scalars.py           # Contains the GraphQL scalar resolvers.
├── schema.graphql       # The complete and raw GraphQL schema.
├── util.py              # Utility functions for GraphQL resolvers.
└── types/               # The resolvers for each GraphQL type.

Note

GraphQL is notorious for having the N+1 problem baked in. However, this doesn't impact SQLite the same way it impacts other RDBMSes.

For more information, see https://sqlite.org/np1queryprob.html.

Schema

For quick reference, the raw GraphQL schema is included below:

.. literalinclude:: ../../../backend/src/graphql/schema.gql
   :linenos:

Utility Functions

.. automodule:: src.graphql.util
   :members: