Blazing fast, instant realtime GraphQL APIs on your DB with fine grained access control, also trigger webhooks on database events.
Go to file
Daniel Chambers 3e2e1f7712 Refactored Flags into a Set and made false flags not serialize (#1424)
### What
OpenDD flags are now stored as a Set of a new Flag enum type. This
allows us to enumerate the flags easily (via the `IntoEnumIterator`
trait), which will be useful in the future to generate a list of
compatibility dates. The new OpenDdFlags set type deserializes to
exactly the same JSON as before, with one exception: any "false" flags
(ie. flags not in the set) are not serialized. This should help newer
MBS build metadata that is compatible with older engine versions that
don't understand newer flags that are disabled and therefore irrelevant.

### How
The main change is in `crates/open-dds/src/flags.rs` where a new
OpenDdFlags type has been created. It is just a wrapper around a
`BTreeSet` of our new `Flag` enum. It has a custom `Serialize`,
`Deserialize` and `JsonSchema` implementation that performs the
serialization we want, and also manually creates the same JsonSchema as
we previously had that matches the serialization.

Unit tests at the bottom of that file perform roundtrip tests and check
that the serialization does what we want.

Now that the flags are not a struct and are instead a set, all usages
change to using `.contains`. You can see this peppered through
metadata_resolve.

In MBS,
`crates/cloud/v3-metadata-build-service/src/build/compatibility/flags.rs`
is where we rework the compatibility date handling to leverage the enum.
We perform a pattern match on it to ensure there's a compatibility date
added for new flags and we now automatically compute the correct flags
to set based on the date using that match and iterating over the flags.

V3_GIT_ORIGIN_REV_ID: 284529db3f346e8eb635a47c9a8fa19d4b8ad207
2024-12-09 03:19:44 +00:00
.circleci add config to prioritize data/error for remote schema fields 2023-12-19 13:30:30 +00:00
.devcontainer/docs docs: add docs devcontainer 2022-12-16 17:39:29 +00:00
.github remove hge-changelog-owners codeowner 2024-09-02 07:24:22 +00:00
architecture streaming subscriptions architecture: update try it out instructions 2022-09-29 17:28:01 +00:00
assets assets: update hasura logos 2024-03-26 18:38:41 +00:00
cabal Jberryman/ghc 9.6.4 2024-01-23 19:47:53 +00:00
cli Allow 14 digit prefixes for migration directories during `hasura scri… 2024-11-25 16:23:13 +00:00
cli-ext cli-ext: Upgrade the node.js version to 16 when packaging. 2023-04-21 09:05:15 +00:00
community server: add hasura_postgres_connection_error_total metric 2024-10-22 11:53:07 +00:00
console Deprecation message in Console Folder Readme 2023-02-28 12:05:04 +00:00
contrib/metadata-types Upgrade Ormolu to 0.7.0.0 2023-05-24 13:53:53 +00:00
dc-agents GHC 9.10.1 2024-08-13 13:41:16 +00:00
docker-compose Use a test PostgreSQL image based on Debian, not Alpine. 2024-07-19 08:18:01 +00:00
docs Docs: Bot route updates 2024-12-03 11:52:57 +00:00
frontend Console: support for session variable in Data tab performance mode for permissions 2024-11-19 05:40:11 +00:00
install-manifests ci: update latest stable release as v2.43.0 2024-09-04 12:51:44 +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: Install ghciwatch and update the flake to get it. 2024-07-31 12:14:17 +00:00
packaging Update ubi9 image for security vulnerabilities for engine 2024-11-21 14:30:05 +00:00
preload-mimalloc Fix #9447 bad memory usage 2023-07-25 11:24:57 +00:00
releases ci: release v2.42.0-beta.1-cloud.1 2024-07-31 12:24:43 +00:00
rfcs server: add hasura_postgres_connection_error_total metric 2024-10-22 11:53:07 +00:00
scripts Stop logging internal actions errors 2024-11-27 18:55:14 +00:00
server ci: catalogue update v2.45.1 2024-12-04 10:25:10 +00:00
translations assets: update hasura logos 2024-03-26 18:38:41 +00:00
v3 Refactored Flags into a Set and made false flags not serialize (#1424) 2024-12-09 03:19:44 +00:00
.dockerignore Create a Docker image specifically for running the Python tests. 2022-09-07 14:29:42 +00:00
.envrc Upgrade GHC to v9.6.5. 2024-05-30 09:38:45 +00:00
.envrc.local.example docker: Always use the official SQL Server image for testing. 2023-09-25 13:27:23 +00:00
.ghcversion Stop logging internal actions errors 2024-11-27 18:55:14 +00:00
.git-blame-ignore-revs frontend: apply prettier 2023-01-25 20:55:24 +00:00
.gitignore Add python script to get cabal package licenses 2024-07-09 21:39:07 +00:00
.hlint.yaml Remove any/all hlint rules 2023-05-18 09:21:20 +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 GHC 9.10.1 2024-08-13 13:41:16 +00:00
cabal.project.freeze GHC 9.10.1 2024-08-13 13:41:16 +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 Update README for open sourcing the v3 engine. 2023-12-21 09:41:45 +00:00
docker-compose.yaml Remove the version from Docker Compose files. 2024-07-17 13:49:05 +00:00
event-triggers.md docs: fix sample-apps URLs 2023-06-30 13:48:19 +00:00
flake.lock Nix: Install ghciwatch and update the flake to get it. 2024-07-31 12:14:17 +00:00
flake.nix Nix: Wrap GHC and HLS, specifically, to provide (DY)?LD_LIBRARY_PATH. 2023-05-22 14:16:12 +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 GHC 9.10.1 2024-08-13 13:41:16 +00:00
README.md Docs: Update README again 2024-08-30 05:26:00 +00:00
remote-schemas.md update docs link to avoid redirects 2021-03-01 18:51:18 +00:00
sample.hie.yaml server: Rename "error-message" to "hasura-error-message". 2023-06-27 16:51:06 +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
V2-README.md assets: update hasura logos 2024-03-26 18:38:41 +00:00
yarn.lock docs: update-rewards-for-disclosures. 2024-04-09 22:27:03 +00:00

Hasura logo Hasura logo

Hasura GraphQL Engine

The Hasura engine is an open source project which supercharges the building of modern applications by providing access to data via a single, composable, secure API endpoint.

Hasura V3

Docs

The future of data delivery is GA: Supporting PostgreSQL (and its flavors), MongoDB, ClickHouse, and MS SQL Server. Also supports writing custom business logic using the Typescript, Python, and Go Connector SDKs. Here is the recommended Getting Started guide on DDN.

The Hasura v3 engine code, which powers Hasura DDN, is in the v3 folder of this repo. You can find more detailed information about in this v3 README.

The Hasura DDN architecture includes Data Connectors to connect to data sources. All Hasura connectors are also available completely open source. Check out the Connector Hub which lists all available connectors.

Hasura V2

Latest release Docs

Hasura V2 is the current stable version of the Hasura GraphQL Engine. Please find more detailed information about the V2 Hasura Graphql Engine in the v2 folder and this README.

Cloning repository

This repository is a large and active mono-repo containing many parts of the Hasura ecosystem and a long git history, that can make the first time cloning of the repository slow and consume a lot of disk space. We recommend following if you are facing cloning issues.

Shallow clone

This will only clone the latest commit and ignore all historical commits.

git clone https://github.com/hasura/graphql-engine.git --depth 1

Git checkout with only Hasura V3 engine code

git clone --no-checkout https://github.com/hasura/graphql-engine.git --depth 1
cd graphql-engine
git sparse-checkout init --cone
git sparse-checkout set v3
git checkout @

This checkouts the top level files and only the v3 folder which contains the Hasura V3 Engine code.

Support & Troubleshooting

To troubleshoot most issues, check out our documentation and community resources. If you have encountered a bug or need to get in touch with us, you can contact us using one of the following channels:

Code of Conduct

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

Security

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

Stay up to date

Join our communities to stay up to date on announcements, events, product updates, and technical blogs. https://hasura.io/community/

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 v2/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. ❤️

Licenses

V3

All the Data Connectors are available under the Apache License 2.0.

The core V3 GraphQL Engine is intended to be licensed under the Apache License 2.0 (Apache-2.0).

V2

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

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