graphql-engine: Build GraphQL APIs Across Your Data

Overview

Hasura GraphQL Engine provides an API layer for applications that need to expose data from databases and other sources through GraphQL. It aims to reduce the work of building and maintaining individual API endpoints, while supporting fine-grained access control and database-event webhooks.

The repository contains both Hasura V2, described as the current stable version, and the V3 engine used by Hasura DDN. It is aimed at teams building data-backed applications that want a composable API and are prepared to choose the version and data connectors that fit their stack.

Key Features

• Exposes data through a single GraphQL API endpoint.
• Supports fine-grained access control.
• Supports triggering webhooks on database events.
• V3 supports PostgreSQL and its flavors, MongoDB, ClickHouse, and MS SQL Server.
• V3 supports custom business logic through TypeScript, Python, and Go Connector SDKs.
• Includes both V2 and V3 engine code in the repository.

Use Cases

• Application teams can expose database-backed data through GraphQL without building each API endpoint themselves.
• Teams with multiple supported data sources can use V3 to compose access to that data through Hasura DDN.
• Developers who need database event-driven integrations can use webhooks triggered by database events.
• Teams that require access rules at the API layer can use Hasura's fine-grained access control.

Getting Started

For a shallow clone of the repository:

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

For setup and version-specific guidance, see the repository README, V2 documentation, and V3 quickstart.

Considerations

• The repository is a large, active monorepo with a long history; cloning the full repository can be slow and use substantial disk space. The README recommends shallow or sparse checkouts when appropriate.
• V2 and V3 have distinct documentation and code locations. Confirm which version fits your deployment before following setup instructions.
• V3 depends on data connectors for its supported sources. Review the connector options and documentation for your intended data source.
• The repository describes V2 as the current stable version and points to V3 documentation for Hasura DDN. Check the relevant version's documentation for current setup and compatibility details.