hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 01:12:56 +03:00
Code Issues Projects Releases Wiki Activity
b0fa87566a
graphql-engine/cli
History
Antoine Leblanc d66d2d81fd server: use placeholder to prevent empty query roots 
### Description

The GraphQL spec has to conflicting requirements:
1. an object must contain at least one field: the schema may not contain empty objects
2. the _query_root_ must always be present

Given _1_, the schema generation code removes from the schema all fields that would result in empty objects, such as a table for which a user does not have select permissions. But, as a result, our code also potentially removes _query_root_ if it is empty, breaking _2_.

This PR introduces a dummy "placeholder" field in the query root if it's empty, to ensure we never remove it from the schema.

### Remaining work

- [x] changelog entry
- [x] tests

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/148
GitOrigin-RevId: bfd6bfcc2f3de92900b6ba566012f093399ca037
2022-01-27 18:08:11 +00:00
..
build ci: add tests for cli-migrations image (#4396) 2020-04-15 07:26:00 +05:30
cmd/hasura cli: update go.mod 2021-06-16 11:45:07 +00:00
commands cli: fix regression with --address flag of hasura console command 2022-01-20 06:41:05 +00:00
integration_test cli: fix regression with --address flag of hasura console command 2022-01-20 06:41:05 +00:00
internal server: use placeholder to prevent empty query roots 2022-01-27 18:08:11 +00:00
migrate cli: wrap errors 2021-12-15 17:55:44 +00:00
pkg cli: misc changes 2022-01-12 13:25:22 +00:00
plugins cli: fix lint errors 2021-10-13 14:39:15 +00:00
seed cli: fix lint errors 2021-10-13 14:39:15 +00:00
telemetry cli: send error to telemetry 2021-09-08 08:56:54 +00:00
update cli: fix lint errors 2021-10-13 14:39:15 +00:00
util cli: stop using healthz endpoint 2022-01-14 04:17:41 +00:00
version cli: throw user friendly errors when server is unreachable 2021-09-27 14:53:44 +00:00
.gitignore cli: show only differences in metadata on metadata diff 2021-06-17 10:16:17 +00:00
.realize.yaml cli: update go-binddata, fix realize (close #3588) (#3687) 2020-01-13 15:24:41 +05:30
cli.go cli: stop using healthz endpoint 2022-01-14 04:17:41 +00:00
CONTRIBUTING.md improve cli contributing.md 2021-12-29 02:19:27 +00:00
directory.go cli: use absolute path of project directory 2021-07-16 12:59:04 +00:00
get.sh tag release v2.1.1 2021-12-17 12:38:06 +00:00
global_config.go cli: fix lint errors 2021-10-13 14:39:15 +00:00
go.mod cli: enhance metadata diff command 2021-12-09 17:26:53 +00:00
go.sum cli: enhance metadata diff command 2021-12-09 17:26:53 +00:00
logger_hook.go cli: add migrate and metadata packages 2021-06-18 06:25:14 +00:00
Makefile cli: codesign the cli binaries 2021-12-02 10:21:30 +00:00
README.md Update README.md 2022-01-10 06:21:05 +00:00

README.md

Hasura GraphQL Engine CLI

GoDoc

Installation

Download GraphQL Engine CLI bundled with Hasura CLI

  • Linux/macOS

    curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | bash

    This will install the Hasura CLI in /usr/local/bin. You might have to provide your sudo password depending on the permissions of your /usr/local/bin location.

    If you’d prefer to install to a different location other than /usr/local/bin, set the INSTALL_PATH variable accordingly:

    curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | INSTALL_PATH=$HOME/bin bash

    You can also install a specific version of the CLI by providing the VERSION variable:

    curl -L https://github.com/hasura/graphql-engine/raw/stable/cli/get.sh | VERSION=v2.1.1 bash

  • Windows

    Download the binary cli-hasura-windows-amd64.exe available under Assets of the latest release from the GitHub release page: https://github.com/hasura/graphql-engine/releases

Download using go get

go get github.com/hasura/graphql-engine/cli/cmd/hasura

Build from source

git clone https://github.com/hasura/graphql-engine
cd graphql-engine/cli
make deps
make build-cli-ext copy-cli-ext
make build
# binaries will be in _output directory

Usage

hasura init --directory <my-project> --endpoint <graphql-endpoint> --admin-secret <admin-secret>
cd <my-project>
hasura console

Contributing

Checkout the contributing guide.