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)

Searching Database…

32.1K ·GitHub
Graphql-engine
这是什么？Hasura 是一个开源引擎，可以基于你的数据库即时生成实时 GraphQL（以及 REST）API，提供细粒度的访问控制，并能在数据库事件发生时触发 Webhook。
这是我可以导入的库，还是需要自己运行的独立服务器？它是一个需要你部署的独立服务器（引擎），而不是可以导入到代码中的库；v3 还允许你通过单独的 Connector SDK（TypeScript、Python、Go）添加自定义业务逻辑。
我该如何开始使用？新版本请按照 Hasura DDN 上推荐的入门指南操作；稳定版 V2 引擎的安装说明记录在 v2 文件夹及其 README 中。
它可以连接哪些数据库？开箱即用，它通过数据连接器支持 PostgreSQL（及其衍生版本）、MongoDB、ClickHouse 和 MS SQL Server；更多连接器可在 Connector Hub 中查看。
我现在应该使用 V2 还是 V3？V2 被明确称为当前的稳定版本，而 V3（DDN）是采用全新架构的较新版本，拥有自己的引擎代码，连接器位于 v3 文件夹中。因此选择哪一个，取决于你更看重稳定性还是最新功能。
它开箱即支持访问控制吗？支持。细粒度访问控制是它的核心特性之一，与即时生成 API 的功能并列。
数据变化时它能触发操作吗？能，它可以在数据库事件发生时触发 Webhook。
为什么克隆这个仓库很慢？有解决办法吗？这是一个庞大且活跃的大型单体仓库，git 历史记录很长，因此 README 建议使用浅克隆，或只检出 v3 引擎文件夹，以加快速度并节省磁盘空间。
在哪里可以找到 Hasura 的 logo 或品牌素材？logo 和 Hasura 吉祥物等品牌素材位于 v2/assets/brand 文件夹中，可免费使用，包括 'Powered by Hasura' 徽章。
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