Git Product home page Git Product logo
graphql-engine

hasura / graphql-engine Goto Github PK

View Code? Open in 1sVSCode Editor NEW
27.3K 330.0 2.2K 1.03 GB

Blazing fast, instant realtime GraphQL APIs on your DB with fine grained access control, also trigger webhooks on database events.

Home Page: https://hasura.io

License: Apache License 2.0

Go 8.61% HTML 0.54% Makefile 0.16% Haskell 38.66% JavaScript 13.04% CSS 2.88% PLpgSQL 0.36% Shell 1.29% Dockerfile 0.12% Python 7.56% PowerShell 0.01% Vue 0.35% TypeScript 25.32% Java 0.04% Ruby 0.02% Lua 0.03% Svelte 0.03% SCSS 0.98% TSQL 0.01% Procfile 0.01%
graphql graphql-server postgres hasura access-control automatic-api api rest-api graphql-api sql-server bigquery mysql haskell

graphql-engine's Introduction

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 Hasura’s 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 flavours), 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 Hasura’s 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 current GPS coordinates moving on a map.

  • A realtime 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.

graphql-engine's People

Contributors

rikinsk avatar rakeshkky avatar shahidhk avatar nicuveo avatar hasura-bot avatar codingkarthik avatar wawhal avatar praveenweb avatar tirumaraiselvan avatar arvi3411301 avatar jberryman avatar 0x777 avatar marionschleifer avatar scriptonist avatar ecthiender avatar scriptnull avatar abooij avatar paf31 avatar vijayprasanna13 avatar sassela avatar lexi-lambda avatar kolharsam avatar abhi40308 avatar Varun-Choudhary avatar solomon-b avatar eviefp avatar purush7 avatar soorajshankar avatar robx avatar plcplc avatar

Stargazers

Patricio Rivera avatar Vincent Lecrubier avatar Diogenes Rodrigues avatar  avatar so1 avatar aokaywe avatar l i a m avatar  avatar Aryan Deshpande avatar Debjit Biswas avatar Andre Piantino avatar Jack Lee avatar  avatar Agustín Cangiani avatar  avatar Peter Clarke avatar  avatar  avatar  avatar amit handa avatar NoDesireMonk avatar Adam Nazar avatar SKYE Dang avatar Daniel Fry avatar Juliano S. avatar John O'Connor avatar  avatar Bill Metangmo avatar Alexey Poimtsev avatar Ronil Biswas avatar  avatar  avatar Bao Nguyen avatar Muhammad Hawash avatar Solaris Nite avatar GithubelseloRo  avatar Abiria avatar Binh Nguyen avatar  avatar Luca Bonfanti avatar Dmitry Ryumkin avatar smoke avatar Iqbal Yusaf avatar Korri Jones avatar Gus Fune avatar Naimul Haque avatar Denis Knyazev avatar T.F. avatar Panayiotis Papageorgiou avatar 好风 avatar Kevin Neaton avatar Nicole Massaro avatar Bete Goshme avatar  avatar Tyler Bigler avatar Spider Man avatar Dominik Helfenstein avatar André Murilo avatar  avatar Danny Burnett avatar  avatar ygkn avatar Parker Queen avatar Justin Chau avatar John Pham avatar Vishnu avatar  avatar ashish avatar Wonho avatar Lucas avatar  avatar Mohammed Raja avatar José Ribeiro avatar  avatar Awais khatab avatar  avatar msenturk avatar Egor K avatar Kurten avatar Hyper Lambda avatar Sergio Veiga avatar Snake avatar  avatar  avatar Denis Ryzhkov avatar yannis avatar suoyuan avatar  avatar Eric Woods avatar Aubrey Falconer avatar Gabriel Ferreira avatar Henrique Sousa avatar Viet Anh Nguyen avatar Hamza Rashid Bodla avatar Cengiz Gürtusgil avatar Ariaseta Setia Alam avatar  avatar MarkTangCd avatar Colton Travers avatar K. A. avatar

Watchers

Ivan Kozik avatar Tamsir SENE avatar Rami Bitar avatar Abhik Khanra avatar Brandon Martin avatar Andrew Phillipo avatar Noam  Vergain avatar Israel Santiago avatar Daniel Hanke avatar German Blejman avatar Maciej Kuś avatar Nguyen Tien Si avatar andy cunningham avatar Tran Phong Phu avatar Ubao Daddy avatar Max Castro avatar Rikin Kachhia avatar Sebastian Macias avatar evandrix avatar AgBorkowski avatar Celvin Rivas avatar Ngai Kam Wing avatar Muescha avatar Maxime Lévesque avatar Rakhmad Azhari avatar Meigo Kukk avatar Cristiano Contin avatar Jochen Rau avatar Everton Yoshitani avatar send2vinnie avatar  avatar Adron Hall avatar alok mishra avatar Richard Hess avatar  avatar Marek Gregor avatar Vik avatar Philip Lykke Carlsen avatar  avatar Benedikt Schmitz avatar Denny Quesada avatar Vladimir Minkin avatar Damien Chaillou avatar Fabio Nascimento avatar ap avatar dujin avatar OneKr-Billy avatar daguswijaya avatar Tibor Kiss avatar Kris Rott avatar Chris Parks avatar Osvaldo avatar Anon Ray avatar zbyufei avatar Aaron Johnson avatar Takeshi Amano avatar Enoi Barrera Guzman avatar Donny Daniel avatar Jinxuan Zhu avatar Thinnakone Bouasavanh avatar James Cloos avatar Guru avatar Kondal Rao Komaragiri avatar  avatar Brandon Wilkins avatar Joe Hosteny avatar Ben Johnston avatar  avatar Saad Talaat avatar Pratik Parikh avatar  avatar shenxiuqiang avatar 玛雅牛 avatar Rui Neto avatar pleclech avatar Yaşar İÇLİ avatar Thibault LAURIANO avatar Florian Neumann avatar Pradeep Saran avatar Konstantin Dyachenko avatar  avatar Aaron Rosen avatar echo avatar  avatar Juri avatar Norberto Ortiz avatar Arya Wiratama avatar  avatar Edward Xie avatar Toan Nguyen  avatar Antoine Leblanc avatar Alexander Melnikov avatar Rajoshi Ghosh avatar Rohit Agarwal avatar Oguz Karadenizli avatar Charlie avatar Mike Slattery avatar Kamal Dev avatar  avatar  avatar

graphql-engine's Issues

change names "raven" in help text of binary

Running graphql-engine -- --help outputs:

raven - Hasura's datastore

Usage: graphql-engine [--host HOST] [-p|--port PORT] [-u|--user USER]
                      [-p|--password PASSWORD] [--database-url DATABASE-URL]
                      [-d|--dbname NAME] COMMAND

Available options:
  -h,--help                Show this help text
  --host HOST              Postgres server host
  -p,--port PORT           Postgres server port
  -u,--user USER           Database user name
  -p,--password PASSWORD   Password of the user
  --database-url DATABASE-URL
                           Postgres database URL. Example
                           postgres://foo:[email protected]:2345/database
  -d,--dbname NAME         Database name to connect to

Available commands:
  serve                    Start the HTTP api server
  export                   Export raven's schema to stdout
  clean                    Clean raven's metadata to start afresh
  execute                  Execute a query

tests fail with directory already exist error

test log
go test -ldflags "-X github.com/hasura/graphql-engine/cli/version.BuildVersion=pull83-d1c525d" ./...
Error: getting manifests failed: failed copying files to temp dir: destination already exists
--- FAIL: TestValidate (0.24s)
	cli_test.go:69: execution failed: getting manifests failed: failed copying files to temp dir: destination already exists
FAIL
FAIL	github.com/hasura/graphql-engine/cli	0.253s
?   	github.com/hasura/graphql-engine/cli/assets	[no test files]
?   	github.com/hasura/graphql-engine/cli/cmd/hasura	[no test files]
ok  	github.com/hasura/graphql-engine/cli/commands	3.441s
?   	github.com/hasura/graphql-engine/cli/migrate	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/api	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/cmd	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/database	[no test files]
ok  	github.com/hasura/graphql-engine/cli/migrate/database/hasuradb	0.007s [no tests to run]
?   	github.com/hasura/graphql-engine/cli/migrate/database/testing	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/source	[no test files]
ok  	github.com/hasura/graphql-engine/cli/migrate/source/file	0.021s
ok  	github.com/hasura/graphql-engine/cli/migrate/source/stub	0.003s
?   	github.com/hasura/graphql-engine/cli/migrate/source/testing	[no test files]
?   	github.com/hasura/graphql-engine/cli/migrate/testing	[no test files]
ok  	github.com/hasura/graphql-engine/cli/util	1.062s
?   	github.com/hasura/graphql-engine/cli/util/fake	[no test files]
ok  	github.com/hasura/graphql-engine/cli/version	0.005s
Makefile:52: recipe for target 'test' failed
make: *** [test] Error 1
Exited with code 2

fix order by

When the order by column is not included in the fields, currently 500, internal error is thrown

server: console assets versioning

If the server version parses as semver, render the console.html template with assets url as vMAJOR.MINOR, for e.g. https://storage.googleapis.com/hasura-graphql-engine/console/v1.0/main.js

If the version fails to parse as semver, render the version itself.

https://storage.googleapis.com/hasura-graphql-engine/console/{{version}}/main.js

cli: server version handling

CLI should support server versions according to the following scheme:

server cli action
non-semver * exact match
vMAJ.MIN >vMAJ.MIN no action
vMAJ.MIN <vMAJ.MIN prompt cli update
- * render 1.0-dev console

mark cypress output directories

add them to .gitignore inside console/cypress, also should be marked as artifact to refer later in case a build/test fails

build/ci-cd system

jobs

  • build

    • server
    • cli
    • console
  • test

    • server
    • cli
    • console
  • deploy

    • server
    • cli
    • console

workflows

pull requests

  • build
  • test

tagged releases

  • build
  • test
  • deploy

release-* branch updates

  • deploy console

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.