graphql-engine README

The project's README from github.com/hasura/graphql-engine. As one markdown file: README.md.

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 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.

graphql-engine (hasura/graphql-engine)

haskell
Searching Database…

32.1K ·GitHub
Graphql-engine
What is this?Hasura is an open source engine that instantly generates realtime GraphQL (and REST) APIs over your databases, with fine-grained access control and the ability to trigger webhooks on database events.
Is this a library I import, or a standalone server I run?It is a standalone server (engine) you deploy, not a library you import into your code; v3 also lets you add custom business logic via separate Connector SDKs (TypeScript, Python, Go).
How do I get started with it?For the new version, follow the recommended Getting Started guide on Hasura DDN; the stable V2 engine has its own setup documented in the v2 folder and its README.
Which databases can it connect to?Out of the box it supports PostgreSQL (and its flavors), MongoDB, ClickHouse, and MS SQL Server, via Data Connectors; more connectors are listed in the Connector Hub.
Is V2 or V3 the one I should use right now?V2 is explicitly called the current stable version, while V3 (DDN) is the newer architecture with its own engine code and connectors living in the v3 folder — so picking the right one depends on whether you want stability or the newest features.
Does it support access control out of the box?Yes, fine-grained access control is one of its headline features alongside instant API generation.
Can it trigger actions when data changes?Yes, it can trigger webhooks on database events.
Why is cloning this repo slow, and is there a fix?It is a large, active mono-repo with a long git history, so the README recommends a shallow clone or checking out only the v3 engine folder to speed things up and save disk space.
Where do I find the Hasura logo or brand assets?Brand assets like logos and the Hasura mascot are available in the v2/assets/brand folder and free to use, including the 'Powered by Hasura' badge.
What are similar projects?parse-server, crystal, cube, postgrest, illa-builder, prisma1, mcp-toolbox, apollo-server
Which topics is it in?graphql-api, automatic-api, bigquery, haskell, sql-server, access-control, postgres, webhooks, graphql, mongodb, mysql, sdk
Creator
hasura
Size
5 GB
Stars
32.1K
Updated
CommitOct 17Releasev2.50.3Sep 09
Age
8y
Commits · 90 Days