graphql-engine/docs/graphql/core/remote-schemas/index.rst

63 lines
1.9 KiB
ReStructuredText
Raw Normal View History

.. meta::
:description: Manage remote schemas with Hasura
:keywords: hasura, docs, remote schema
.. _remote_schemas:
Remote Schemas
==============
.. contents:: Table of contents
:backlinks: none
:depth: 1
:local:
Introduction
------------
Hasura gives you CRUD + realtime GraphQL APIs with authorization & access control. However, in many cases, you will
need to write APIs (queries, mutations) that contain custom logic. For example, implementing a payment API, or
querying data that is not in your database.
Hasura has the ability to merge remote GraphQL schemas and provide a unified GraphQL API. Think of it
like automated schema stitching. All you need to do is build your own GraphQL service and then provide the HTTP
endpoint to Hasura. Your GraphQL service can be written in any language or framework.
This is what Hasura running with "Remote schemas" looks like:
.. thumbnail:: /img/graphql/core/remote-schemas/remote-schema-arch.png
:class: no-shadow
:width: 900px
:alt: Architecture of Hasura with remote schemas
2019-09-11 10:17:14 +03:00
Use cases
---------
- Custom business logic, like a payment API
- Querying data that is not available in your database
2019-09-11 10:17:14 +03:00
You can handle these use cases by writing resolvers in a custom GraphQL server
and making Hasura merge this "remote schema" with the existing auto-generated
schema. You can also add multiple remote schemas. Think of the merged schema as
a union of top-level nodes from each of the sub-schemas.
.. note::
If you are looking for adding authorization & access control for your
app users to the GraphQL APIs that are auto-generated via Hasura, head to
:ref:`auth`
Remote schema relationships
---------------------------
You can create remote relationships between your tables and tables from your remote schema. Read more about this in the :ref:`remote_schema_relationships` section.
**See:**
.. toctree::
:maxdepth: 1
adding-schema
schema-auth