Blazing fast, instant realtime GraphQL APIs on your DB with fine grained access control, also trigger webhooks on database events.
Go to file
Antoine Leblanc 0aaf006c25 server: add metadata for DB-DB remote joins
### Description

This PR is the first of several PRs meant to introduce Generalized Joins. In this first PR, we add non-breaking changes to the Metadata types for DB-to-DB remote joins. Note that we are currently rejecting the new remote join format in order to keep folks from breaking their metadata (in case of a downgrade). These issues will be tackled (and JSON changes reverted) in subsequent PRs.

This PR also changes the way we construct the schema cache, and breaks the way we process sources in two steps: we first resolve each source and construct a cache of their tables' raw info, then in a second step we build the source output. This is so that we have access to the target source's tables when building db-to-db relationships.

### Notes

- this PR contains a few minor cleanups of the schema
- it also fixes a bug in how we do renames in remote schema relationships
- it introduces cross-source schema dependencies

https://github.com/hasura/graphql-engine-mono/pull/1727

Co-authored-by: Evie Ciobanu <1017953+eviefp@users.noreply.github.com>
GitOrigin-RevId: f625473077bc5fff5d941b70e9a116192bc1eb22
2021-07-22 23:07:10 +00:00
.circleci server: inherited roles improvements for select permissions only 2021-07-16 21:19:58 +00:00
.github ci: improve hlint messages 2021-05-04 21:52:55 +00:00
architecture docs: update sql-server.md 2021-06-18 13:30:57 +00:00
assets Notes on Hasura & SQL Server support 2021-06-17 14:36:46 +00:00
cli cli: use absolute path of project directory 2021-07-16 12:59:04 +00:00
cli-ext cli: support ARM architecture 2021-07-14 08:54:43 +00:00
community remove migrations webinar in docs, fix conflict in sample apps 2021-03-15 08:34:49 +00:00
console console: enable bigquery in connect db form for cloud console 2021-07-22 11:48:12 +00:00
contrib/metadata-types add github workflow to compress new images in PRs 2021-03-10 20:55:02 +00:00
docs update docker install manifest for simpler PG getting started 2021-07-22 13:53:40 +00:00
install-manifests update docker install manifest for simpler PG getting started 2021-07-22 13:53:40 +00:00
rfcs server: inherited roles improvements for select permissions only 2021-07-16 21:19:58 +00:00
scripts server/citus: pin docker image tag 2021-07-22 15:46:18 +00:00
server server: add metadata for DB-DB remote joins 2021-07-22 23:07:10 +00:00
translations update docs link to avoid redirects 2021-03-01 18:51:18 +00:00
.gitignore docs: add cloud docs header (#5171) 2020-06-22 21:48:04 +05:30
.kodiak.toml ci: sets include_pr_number kodiak config to false (#1569) 2021-06-14 15:21:56 +00:00
CHANGELOG.md bigquery: pass the location when fetching a job's status 2021-07-22 15:00:16 +00:00
code-of-conduct.md update code of conduct (#2886) 2019-09-16 14:07:52 +05:30
CONTRIBUTING.md community: update contrib guide (#5866) 2020-10-01 10:03:30 +02:00
event-triggers.md update docs link to avoid redirects 2021-03-01 18:51:18 +00:00
LICENSE Change license for core GraphQL Engine to Apache 2.0 (#1821) 2019-03-19 16:23:36 +05:30
LICENSE-community add community boilerplates and examples (#430) 2018-09-13 12:00:07 +05:30
README.md update docs link to avoid redirects 2021-03-01 18:51:18 +00:00
remote-schemas.md update docs link to avoid redirects 2021-03-01 18:51:18 +00:00
SECURITY.md translation(hindi): add security.md (#3162) 2020-01-05 11:32:23 +05:30

Hasura GraphQL Engine

Latest release Docs CircleCI

Hasura GraphQL Engine is a blazing-fast GraphQL server that gives you instant, realtime GraphQL APIs over Postgres, with webhook triggers on database events, and remote schemas for business logic.

Hasura helps you build GraphQL apps backed by Postgres or incrementally move to GraphQL for existing applications using Postgres.

Read more at hasura.io and the docs.


Hasura GraphQL Engine Demo


Hasura GraphQL Engine Realtime Demo


Features

  • Make powerful queries: Built-in filtering, pagination, pattern search, bulk insert, update, delete mutations
  • Realtime: Convert any GraphQL query to a live query by using subscriptions
  • Merge remote schemas: Access custom GraphQL schemas for business logic via a single GraphQL Engine endpoint. Read more.
  • Trigger webhooks or serverless functions: On Postgres insert/update/delete events (read more)
  • Works with existing, live databases: Point it to an existing Postgres database to instantly get a ready-to-use GraphQL API
  • Fine-grained access control: Dynamic access control that integrates with your auth system (eg: auth0, firebase-auth)
  • High-performance & low-footprint: ~15MB docker image; ~50MB RAM @ 1000 req/s; multi-core aware
  • Admin UI & Migrations: Admin UI & Rails-inspired schema migrations
  • Postgres ❤️: Supports Postgres types (PostGIS/geo-location, etc.), turns views to graphs, trigger stored functions or procedures with mutations

Read more at hasura.io and the docs.

Table of contents

Table of Contents

Quickstart:

One-click deployment on Hasura Cloud

The fastest and easiest way to try Hasura out is via Hasura Cloud.

  1. Click on the following button to deploy GraphQL engine on Hasura Cloud including Postgres add-on or using an existing Postgres database:

    Deploy to Hasura Cloud

  2. Open the Hasura console

    Click on the button "Launch console" to open the Hasura console.

  3. Make your first GraphQL query

    Create a table and instantly run your first query. Follow this simple guide.

Other one-click deployment options

Check out the instructions for the following one-click deployment options:

Infra provider One-click link Additional information
Heroku Deploy to Heroku docs
DigitalOcean Deploy to DigitalOcean docs
Azure Deploy to Azure docs
Render Deploy to Render docs

Other deployment methods

For Docker-based deployment and advanced configuration options, see deployment guides or install manifests.

Architecture

The Hasura GraphQL Engine fronts a Postgres database instance and can accept GraphQL requests from your client apps. It can be configured to work with your existing auth system and can handle access control using field-level rules with dynamic variables from your auth system.

You can also merge remote GraphQL schemas and provide a unified GraphQL API.

Hasura GraphQL Engine architecture

Client-side tooling

Hasura works with any GraphQL client. We recommend using Apollo Client. See awesome-graphql for a list of clients.

Add business logic

GraphQL Engine provides easy-to-reason, scalable and performant methods for adding custom business logic to your backend:

Remote schemas

Add custom resolvers in a remote schema in addition to Hasura's Postgres-based GraphQL schema. Ideal for use-cases like implementing a payment API, or querying data that is not in your database - read more.

Trigger webhooks on database events

Add asynchronous business logic that is triggered based on database events. Ideal for notifications, data-pipelines from Postgres or asynchronous processing - read more.

Derived data or data transformations

Transform data in Postgres or run business logic on it to derive another dataset that can be queried using GraphQL Engine - read more.

Demos

Check out all the example applications in the community/sample-apps directory.

Realtime applications

Videos

Support & Troubleshooting

The documentation and community will help you troubleshoot most issues. If you have encountered a bug or need to get in touch with us, you can contact us using one of the following channels:

We are committed to fostering an open and welcoming environment in the community. Please see the Code of Conduct.

If you want to report a security issue, please read this.

Contributing

Check out our contributing guide for more details.

Brand assets

Hasura brand assets (logos, the Hasura mascot, powered by badges etc.) can be found in the assets/brand folder. Feel free to use them in your application/website etc. We'd be thrilled if you add the "Powered by Hasura" badge to your applications built using Hasura. ❤️

<!-- For light backgrounds -->
<a href="https://hasura.io">
  <img width="150px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_blue.svg" />
</a>

<!-- For dark backgrounds -->
<a href="https://hasura.io">
  <img width="150px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_white.svg" />
</a>

License

The core GraphQL Engine is available under the Apache License 2.0 (Apache-2.0).

All other contents (except those in server, cli and console directories) are available under the MIT License. This includes everything in the docs and community directories.

Translations

This readme is available in the following translations:

Translations for other files can be found here.