Skip to content

Latest commit

 

History

History
217 lines (144 loc) · 10.8 KB

README.md

File metadata and controls

217 lines (144 loc) · 10.8 KB
Raw

Hasura GraphQL Engine

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 Heroku

The fastest way to try Hasura out is via Heroku.

  1. Click on the following button to deploy GraphQL Engine on Heroku with the free Postgres add-on:

    Deploy to Heroku

  2. Open the Hasura console

    Visit https://<app-name>.herokuapp.com (replace <app-name> with your app name) to open the admin 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
DigitalOcean Deploy to DigitalOcean docs
Azure Deploy to Azure 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.