Blazing fast, instant realtime GraphQL APIs on your DB with fine grained access control, also trigger webhooks on database events.
Go to file
Samir Talwar b167aa84d1 console: Add readOnly: true in a few places where necessary.
I set up a local PostgreSQL read replica, loaded the Chinook dataset, and poked around finding bugs here and there. I added `read_only: true` to the relevant SQL queries to mitigate these.

I did not test exhaustively or even that well, and I only tried this with PostgreSQL, so I am sure that I have missed some, but this at least seems to make the console's Data tab usable.

Note that this removes the check for the `READ_ONLY_RUN_SQL_QUERIES` feature flag, which seems pointless, as it's checking whether we're running v1.1.0 of the HGE server or later. I sincerely hope no one is actually running such an old version.

If this change is acceptable, we can probably remove the feature flag logic entirely, but that is not something I want to do here.

[DSF-218]: https://hasurahq.atlassian.net/browse/DSF-218?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/8451
Co-authored-by: Luca Restagno <59067245+lucarestagno@users.noreply.github.com>
GitOrigin-RevId: 5f4ebfa8f44e2921071699085b877db78aaa4e24
2023-03-27 22:57:05 +00:00
.circleci server: move apollo-federation to GA 2023-03-15 08:15:51 +00:00
.devcontainer/docs docs: add docs devcontainer 2022-12-16 17:39:29 +00:00
.github Improve the tone of the OSS issue templates by removing questions 2022-10-19 02:21:46 +00:00
architecture streaming subscriptions architecture: update try it out instructions 2022-09-29 17:28:01 +00:00
assets updated readme gif 2022-02-24 09:38:54 +00:00
cabal chore(server): stricter GHC warnings for libraries 2023-03-14 17:01:46 +00:00
cli cli: add support for sources.logical_models in metadata 2023-03-27 08:00:27 +00:00
cli-ext Deprecation message in Console Folder Readme 2023-02-28 12:05:04 +00:00
community community: add graphql benchmark 2023-02-27 13:15:01 +00:00
console Deprecation message in Console Folder Readme 2023-02-28 12:05:04 +00:00
contrib/metadata-types contrib: Metadata V3 types + JSON Schema 2021-11-10 05:37:11 +00:00
dc-agents Fix "limit" from permissions being incorrectly applied to aggregates in Data Connectors 2023-03-20 04:02:23 +00:00
docker-compose feature(server): add Logical Models support for CockroachDB 2023-03-27 14:00:07 +00:00
docs docs: move caching to top-level 2023-03-27 16:21:05 +00:00
frontend console: Add readOnly: true in a few places where necessary. 2023-03-27 22:57:05 +00:00
install-manifests Docs: Oracle 2023-03-17 07:03:58 +00:00
metadata-api-types Make command to generate types from typed metadata in languages other than Typescript 2023-03-14 14:27:15 +00:00
nix nix: Bake the ODBC configuration path into unixODBC. 2023-03-25 20:55:47 +00:00
packaging ci: update base image 2023-03-15 11:52:21 +00:00
rfcs rfc: warning in replace_metadata metadata API 2023-03-06 06:32:24 +00:00
scripts make: Set a base for all nx commands. 2023-03-27 22:24:31 +00:00
server CI: Get the GHC version from VERSIONS.json for all GitHub workflows. 2023-03-27 18:53:18 +00:00
translations Deprecation message in Console Folder Readme 2023-02-28 12:05:04 +00:00
.dockerignore Create a Docker image specifically for running the Python tests. 2022-09-07 14:29:42 +00:00
.envrc direnv: Default to the Azure SQL Edge image on macOS. 2022-10-24 15:54:41 +00:00
.envrc.local.example Nix: Upgrade to GHC 9.2.4. 2022-10-06 21:05:34 +00:00
.ghcversion ghc 9.2.5 2022-11-15 11:26:42 +00:00
.git-blame-ignore-revs frontend: apply prettier 2023-01-25 20:55:24 +00:00
.gitignore fix: add node modules to gitignore 2023-03-03 07:19:48 +00:00
.hlint.yaml chore(server): revamp hlint config and add new undefined rule 2023-03-20 08:41:59 +00:00
.kodiak.toml ci: don't block merge queue when awaiting review, after #7011 2023-02-07 20:31:27 +00:00
.nvmrc tooling: bump .nvmrc version to 16 2022-09-06 11:23:56 +00:00
.prettierignore Add a missing changelog entry for error message changes to v2.10.0. 2022-09-05 09:41:06 +00:00
cabal.project server: use ekg-prometheus v0.3.0.0 2023-03-15 23:51:00 +00:00
cabal.project.freeze server: use ekg-prometheus v0.3.0.0 2023-03-15 23:51:00 +00:00
CHANGELOG.md Kriti Documentation 2022-09-06 15:47:18 +00:00
code-of-conduct.md update code of conduct (#2886) 2019-09-16 14:07:52 +05:30
CONTRIBUTING.md Deprecation message in Console Folder Readme 2023-02-28 12:05:04 +00:00
docker-compose.yaml server/api-tests: Add a Docker Compose file for the API tests. 2023-01-16 16:44:10 +00:00
event-triggers.md docs: update the hasura sample apps links 2022-02-18 17:06:46 +00:00
flake.lock nix: Switch to nixpkgs-unstable. 2023-03-24 20:36:48 +00:00
flake.nix nix: Switch to nixpkgs-unstable. 2023-03-24 20:36:48 +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
Makefile make: Add make targets for formatting and linting frontend code. 2023-03-23 15:16:14 +00:00
metadata.openapi.json feature(server): ordered columns in Logical Model return type 2023-03-22 16:35:56 +00:00
package-lock.json console: Update Cypress to v10 and run the migration guide 2022-07-05 08:51:35 +00:00
README.md docs: add Hasura logo (fix #5934 ) 2022-12-21 04:03:48 +00:00
remote-schemas.md update docs link to avoid redirects 2021-03-01 18:51:18 +00:00
sample.hie.yaml [ci] test the libraries in server/lib 2023-02-02 17:32:48 +00:00
SECURITY.md github md pages: update email address for security team 2022-12-01 17:19:51 +00:00
shell.nix Push the Nix dependency management configuration to the OSS repository. 2022-10-11 15:33:22 +00:00
weeder.dhall remove homebrew NESeq, use vendored 2022-07-19 08:42:28 +00:00

Hasura GraphQL Engine

Latest release Docs

Hasura is an open-source product that accelerates API development by 10x by giving you GraphQL or REST APIs with built-in authorization on your data, instantly.

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
  • Works with existing, live databases: Point it to an existing database to instantly get a ready-to-use GraphQL API
  • 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.
  • Extend with Actions: Write REST APIs to extend Hasuras schema with custom business logic.
  • Trigger webhooks or serverless functions: On Postgres insert/update/delete events (read more)
  • Scheduled Triggers: Execute custom business logic at specific points in time using a cron config or a one-off event.
  • Fine-grained access control: Dynamic access control that integrates with your auth system (eg: auth0, firebase-auth)
  • Admin UI & Migrations: Admin UI & Rails-inspired schema migrations
  • Supported Databases: Supports PostgreSQL (and its flavors), MS SQL Server and Big Query. Support for more databases coming soon.

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. See awesome-graphql for a list of clients. Our frontend tutorial series also have integrations with GraphQL clients for different frameworks.

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 database-based GraphQL schema. Ideal for use-cases like implementing a payment API, or querying data that is not in your database - read more.

Actions

Actions are a way to extend Hasuras schema with custom business logic using custom queries and mutations. Actions can be added to Hasura to handle various use cases such as data validation, data enrichment from external sources and any other complex business logic - 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

  • Group Chat application built with React, includes a typing indicator, online users & new message notifications.

  • Live location tracking app that shows a running vehicle changing the current GPS coordinates moving on a map.

  • A real-time dashboard for data aggregations on continuously changing data.

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.

Stay up to date

We release new features every month. Sign up for our newsletter by using the link below. We send newsletters only once a month. https://hasura.io/newsletter/

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_primary_darkbg.svg" />
</a>

<!-- For dark backgrounds -->
<a href="https://hasura.io">
  <img width="150px" src="https://graphql-engine-cdn.hasura.io/img/powered_by_hasura_primary_lightbg.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.