Skip to content

Fix typos #10692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ Event Triggers support has been added for MS SQL Server. Now, you can invoke ext
- cli: fix performance regression with large metadata in `metadata apply`
- cli: fix error reporting in `metadata apply` command (#8280)
- server: query runtime performance optimizations
- server: fix bug that had disabled expression-based indexes in Postgress variants (fix Zendesk 5146)
- server: fix bug that had disabled expression-based indexes in Postgres variants (fix Zendesk 5146)
- server: add optionality to additional postgres-client-cert fields: sslcert, sslkey and sslpassword

## v2.8.1
Expand Down Expand Up @@ -1452,7 +1452,7 @@ Response 2:
- server: add metadata inconsistency information in `reload_metadata` API call
- server: add custom function for case insensitive lookup in session variable in request transformation
- server: Improved error messaging for `test_webhook_transform` metadata API endpoint
- server: Webhook Tranforms can now produce `x-www-url-formencoded` bodies.
- server: Webhook Transforms can now produce `x-www-url-formencoded` bodies.
- server: Webhook Transforms can now delete request/response bodies explicitly.
- server: Fix truncation of session variables with variable length column types in MSSQL (#8158)
- server: improve performance of `replace_metadata` for large schemas
Expand Down Expand Up @@ -1508,7 +1508,7 @@ The optimization can be enabled using the
- server: MSSQL generates correct SQL when object relationships are null.
- console: add support for remote database relationships
- console: enable support for update permissions for mssql
- cli: skip tls verfication for all API requests when `insecure-skip-tls-verify` flag is set (fix #4926)
- cli: skip tls verification for all API requests when `insecure-skip-tls-verify` flag is set (fix #4926)
- server: fix issues working with read-only DBs by reverting the need for storing required SQL functions in a `hdb_lib` schema in the user's DB
- server: Fix experimental sql optimization read from `HASURA_GRAPHQL_EXPERIMENTAL_FEATURES` or `--experimental-features`

Expand Down Expand Up @@ -1676,7 +1676,7 @@ count (
- server: fixes JSON ser/de backwards incompatibility introduced for metadata parsing and 'create_remote_relationship' queries (#7906)
- console: add sample context section to webhook transforms
- cli: `hasura metadata diff` shows diff with more context in directory mode
- cli: revert change to split metadata related to remote schemas into seperate files (introduced in v2.1.0-beta.2)
- cli: revert change to split metadata related to remote schemas into separate files (introduced in v2.1.0-beta.2)

## v2.1.0-beta.3

Expand Down Expand Up @@ -1760,11 +1760,11 @@ source.
- console: fix v2 metadata imports
- console: design cleanup Modify and Add Table forms (close #7454)
- console: enable custom graphql root fields for mssql under modify tab
- cli: split remote schema permissions metadata into seperate files (#7033)
- cli: split remote schema permissions metadata into separate files (#7033)
- cli: support action request transforms in metadata
- cli: make `--database-name` optional in `migrate` subcommands when using a single database (#7434)
- cli: support absolute paths in --envfile (#5689)
- cli: split remote schema permissions metadata into seperate files (#7033)
- cli: split remote schema permissions metadata into separate files (#7033)

## v2.0.10

Expand Down Expand Up @@ -1802,7 +1802,7 @@ source.
- console: fix missing cross-schema computed fields in permission builder
- console: add time limits setting to security settings
- cli: add support for `network` metadata object
- cli: `hasura migrate apply --all-databases` will return a non zero exit code if operation failed on atleast one database (#7499)
- cli: `hasura migrate apply --all-databases` will return a non zero exit code if operation failed on at least one database (#7499)
- cli: `migrate create --from-server` creates the migration and marks it as applied on the server
- cli: support `query_tags` in metadata
- cli: add `hasura deploy` command
Expand Down Expand Up @@ -1967,7 +1967,7 @@ NOTE: This only includes the diff between v2.0.0 and v2.0.0-beta.2
- console: update connect database form with SSL certificates
- console: add drop table functionality to MS SQL Server tables
- console: allow renaming data sources
- console: show error notification for table and cloumn names exceeding 63 characters and trim migration names exceeding 255 characters
- console: show error notification for table and column names exceeding 63 characters and trim migration names exceeding 255 characters
- cli: fix version command using stderr as output stream (#6998)

## v2.0.0-alpha.11
Expand Down Expand Up @@ -2586,7 +2586,7 @@ arguments.
- server: add action-like URL templating for event triggers and remote schemas (fixes #2483)
- server: change `created_at` column type from `timestamp` to `timestamptz` for scheduled triggers tables (fix #5722)
- server: allow configuring timeouts for actions (fixes #4966)
- server: fix bug which arised when renaming a table which had a manual relationship defined (close #4158)
- server: fix bug which arose when renaming a table which had a manual relationship defined (close #4158)
- server: limit the length of event trigger names (close #5786)
**NOTE:** If you have event triggers with names greater than 42 chars, then you should update their names to avoid running into Postgres identifier limit bug (#5786)
- server: enable HASURA_GRAPHQL_PG_CONN_LIFETIME by default to reclaim memory
Expand All @@ -2597,7 +2597,7 @@ arguments.
- server: fix event trigger cleanup on deletion via replace_metadata (fix #5461) (#6137)
**WARNING**: This can cause significant load on PG on startup if you have lots of event triggers. Delay in starting up is expected.
- console: add notifications (#5070)
- cli: fix bug in metadata apply which made the server aquire some redundant and unnecessary locks (close #6115)
- cli: fix bug in metadata apply which made the server acquire some redundant and unnecessary locks (close #6115)
- cli: fix cli-migrations-v2 image failing to run as a non root user (close #4651, close #5333)
- cli: fix issue with cli binary on latest Mac (Big Sur) (fix #5462)
- docs: add docs page on networking with docker (close #4346) (#4811)
Expand Down Expand Up @@ -2869,7 +2869,7 @@ using this flag is insecure since verification is not carried out.

- console: update graphiql explorer to support operation transform (#4567)
- console: make GraphiQL Explorer taking the whole viewport (#4553)
- console: fix table columns type comparision during column edit (close #4125) (#4393)
- console: fix table columns type comparison during column edit (close #4125) (#4393)
- cli: allow initialising project in current directory (fix #4560) #4566
- cli: remove irrelevant flags from init command (close #4508) (#4549)
- docs: update migrations docs with config v2 (#4586)
Expand Down Expand Up @@ -2898,7 +2898,7 @@ available for `admin` role requests. To enable this for other roles, start the s
$ graphql-engine --database-url <database-url> serve --dev-mode
```

In case you want to disable `internal` field for `admin` role requests, set `--admin-internal-errors` option to `false` or or set `HASURA_GRAPHQL_ADMIN_INTERNAL_ERRORS` env variable to `false`
In case you want to disable `internal` field for `admin` role requests, set `--admin-internal-errors` option to `false` or set `HASURA_GRAPHQL_ADMIN_INTERNAL_ERRORS` env variable to `false`

```bash
$ graphql-engine --database-url <database-url> serve --admin-internal-errors false
Expand Down Expand Up @@ -3035,7 +3035,7 @@ For example, see [here](https://hasura.io/docs/latest/graphql/core/api-reference
- server: support inserting unquoted bigint, and throw an error if value overflows the bounds of the integer type (fix #576) (fix #4368)
- console: change react ace editor theme to eclipse (close #4437)
- console: fix columns reordering for relationship tables in data browser (#4483)
- console: format row count in data browser for readablity (#4433)
- console: format row count in data browser for readability (#4433)
- console: move pre-release notification tooltip msg to top (#4433)
- console: remove extra localPresets key present in migration files on permissions change (close #3976) (#4433)
- console: make nullable and unique labels for columns clickable in insert and modify (#4433)
Expand All @@ -3044,7 +3044,7 @@ For example, see [here](https://hasura.io/docs/latest/graphql/core/api-reference
- docs: add API docs for using environment variables as webhook urls in event triggers
- server: fix recreating action's permissions (close #4377)
- server: make the graceful shutdown logic customizable (graceful shutdown on the SIGTERM signal continues to be the default)
- docs: add reference docs for CLI (clsoe #4327) (#4408)
- docs: add reference docs for CLI (close #4327) (#4408)

## `v1.2.0-beta.4`

Expand Down Expand Up @@ -3080,7 +3080,7 @@ The order, collapsed state of columns and rows limit is now persisted across pag
- server: reserved keywords in column references break parser (fix #3597) #3927
- server: fix postgres specific error message that exposed database type on invalid query parameters (#4294)
- server: manage inflight events when HGE instance is gracefully shutdown (close #3548)
- server: fix an edge case where some events wouldn't be processed because of internal erorrs (#4213)
- server: fix an edge case where some events wouldn't be processed because of internal errors (#4213)
- server: fix downgrade not working to version v1.1.1 (#4354)
- server: `type` field is not required if `jwk_url` is provided in JWT config
- server: add a new field `claims_namespace_path` which accepts a JSON Path for looking up hasura claim in the JWT token (#4349)
Expand Down
8 changes: 4 additions & 4 deletions architecture/sql-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Once you have Hasura running:

### Replace direct database access with flexible JSON APIs over HTTP
- Modern workloads in the cloud or end-user web/mobile apps need a flexible and secure API over HTTP to access data
- Use Hasura to to get a data API instantly, instead of having to build and maintain an API server
- Use Hasura to get a data API instantly, instead of having to build and maintain an API server


## How Hasura Works
Expand All @@ -111,7 +111,7 @@ Because of its compiler-like architecture Hasura can avoid N+1 issues entirely.
There are 3 key aspects to this:

**Compiling into a SQL query:**
- Instead of resolving a GraphQL query piece by piece, Hasura tries to compile parts of the query to a single data source, into a single query that an upstread source can understand - in this case, a SQL query for SQL Server.
- Instead of resolving a GraphQL query piece by piece, Hasura tries to compile parts of the query to a single data source, into a single query that an upstream source can understand - in this case, a SQL query for SQL Server.
- This is especially impactful when dealing with authorization rules since they can be compiled into the same query as the data fetch instead of having to make multiple requests to the data source.
- Read more about Hasura’s [compiler architecture](https://hasura.io/blog/architecture-of-a-high-performance-graphql-to-sql-server-58d9944b8a87/) and its [subscription mechanism](https://github.com/hasura/graphql-engine/blob/master/architecture/live-queries.md).

Expand Down Expand Up @@ -175,7 +175,7 @@ Here are a few examples of types of authorization rules that can be implemented
#### Ex 4: Allow roles to inherit from other roles
- Compose roles to intelligently merge into a single permission policy
- Hasura composes roles preserving row and field level access using a "cell based nullification" merge algorithm
- This allows Hasura users to specifcy different levels of ownership and visibility on the same data models easily
- This allows Hasura users to specify different levels of ownership and visibility on the same data models easily
- Example: Allow a user to fetch all the fields of their own profile, but only some data for profiles that aren't theirs
```yaml
# Role 1
Expand Down Expand Up @@ -214,7 +214,7 @@ Next up on our roadmap for Hasura + SQL Server:

- [#7073](https://github.com/hasura/graphql-engine/issues/7073) Support for stored procedures & functions
- [#7074](https://github.com/hasura/graphql-engine/issues/7074) Mutations: Run inserts, updates, deletes, stored procedures and transactions securely on SQL Server over a GraphQL API
- [#7075]() Event triggers: Trigger HTTP webhooks with atomic capture and atleast once guarantee whenever data changes inside the database [(read more)](https://hasura.io/docs/latest/graphql/core/event-triggers/index.html)
- [#7075]() Event triggers: Trigger HTTP webhooks with atomic capture and at least once guarantee whenever data changes inside the database [(read more)](https://hasura.io/docs/latest/graphql/core/event-triggers/index.html)
- [#7076](https://github.com/hasura/graphql-engine/issues/7076) Remote Joins: Join models in SQL Server to models from other API services (GraphQL or REST)

Please do upvote / subscribe to the issues above to stay updated! We estimate these to be available over incremental releases in July/Aug 2021.
2 changes: 1 addition & 1 deletion architecture/streaming-subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ of subscriptions.

We have seen how Hasura makes performant queries. But what about Authorization?

The naive approach would be to fetch the data from the database (involves IO), apply authorization checks for each element in the response (involes IO and compute) and then send the result back to the client. The problem with this approach is that the initial data fetch is not definitive. The data is being filtered based on rules post the fetching from the database and as data becomes bigger, compute and latency becomes high and so does the load on the database.
The naive approach would be to fetch the data from the database (involves IO), apply authorization checks for each element in the response (involves IO and compute) and then send the result back to the client. The problem with this approach is that the initial data fetch is not definitive. The data is being filtered based on rules post the fetching from the database and as data becomes bigger, compute and latency becomes high and so does the load on the database.

It is impossible to load large streams of data in memory and apply authorization rules for filtering data before sending it back to the client. The Hasura approach to this problem is two fold. Make the data fetching performant and make authorization declarative by applying them at the query layer.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ TODO: document on how to deploy on docker.

You can also have a look at [this docker-compose gist](https://gist.github.com/plmercereau/b8503c869ffa2b5d4e42dc9137b56ae1) to see how I use this service in a docker stack with Hasura and [Traefik](https://traefik.io/).

### Deploy locally (developpment)
### Deploy locally (development)

```bash
# Clone the repo
Expand Down Expand Up @@ -172,7 +172,7 @@ curl -H "Content-Type: application/json" \
http://localhost:8080/login
```

It will then send back user information including the JWT in the same format as the above `/signup` endoint.
It will then send back user information including the JWT in the same format as the above `/signup` endpoint.

You can use this boilerplate as a webhook server in using the `/webhook` endpoint to fetch a webhook token:

Expand Down
2 changes: 1 addition & 1 deletion community/boilerplates/event-triggers/aws-lambda/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Sample cloud functions that can be triggered on changes in the database using Gr
These are organized in language-specific folders.

**NOTE**
Some of the language/platforms are work in progress. We welcome contributions for the WIP langauages. See issues and the following checklist:
Some of the language/platforms are work in progress. We welcome contributions for the WIP languages. See issues and the following checklist:

| Folder name | Use-case| Node.js(6) | Python | Java | Go | C# | Ruby
|-------------|---------|:--------:|:------:|:----:|:---:|:---:|:---:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Create a lambda function in AWS. This will be our webhook.
6. Add API gateway as a trigger.
7. Add an API to API gateway.
8. Upload the zip from previous step. The handler function of your lambda will be `index.handler`.
9. Add the following enviroment variables in your lambda config:
9. Add the following environment variables in your lambda config:
1. `ADMIN_SECRET`: this is the admin secret key you configured when you setup HGE.
2. `HGE_ENDPOINT`: the URL on which you HGE instance is running.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Create a lambda function in AWS. This will be our webhook.
6. Add API gateway as a trigger.
7. Add an API to API gateway.
8. Upload the zip from previous step. The handler function of your lambda will be `index.handler`.
9. Add the following enviroment variables in your lambda config:
9. Add the following environment variables in your lambda config:
1. `ACCESS_KEY`: this is the access key you configured when you setup HGE.
2. `HGE_ENDPOINT`: the URL on which you HGE instance is running.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Create a lambda function in AWS. This will be our webhook.
4. Add API gateway as a trigger.
5. Add an API to API gateway.
6. Add the code in `mutation.py`. The handler function of your lambda will be the `mutation.lambda_handler`.
7. Add the following enviroment variables in your lambda config:
7. Add the following environment variables in your lambda config:
1. `ADMIN_SECRET`: this is the admin secret key you configured when you setup HGE.
2. `HGE_ENDPOINT`: the URL on which you HGE instance is running.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Create a lambda function in AWS. This will be our webhook.
1. Add API gateway as a trigger (in this example you can use Open as the security option).
1. Add an API to API gateway.
1. Add the code in `lambda_function.rb` to the lambda function editor. The handler function of your lambda will be the lambda_handler.
1. Add the following enviroment variables in your lambda config:
1. Add the following environment variables in your lambda config:
1. `ACCESS_KEY`: this is the access key you configured when you setup HGE (`HASURA_GRAPHQL_ADMIN_SECRET` env variable).
1. `HGE_ENDPOINT`: the URL on which you HGE instance is running.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Sample cloud functions that can be triggered on changes in the database using GraphQL Engine's Event Triggers

**NOTE**
Some of the language/platforms are work in progress. We welcome contributions for the WIP langauages. See issues and the following checklist:
Some of the language/platforms are work in progress. We welcome contributions for the WIP languages. See issues and the following checklist:

| Folder name | Use-case| Node.js(8) | Node.js(6) | Python
|-------------|---------|:--------:|:------:|:----:
Expand Down
2 changes: 1 addition & 1 deletion community/boilerplates/observability/enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The default GraphQL Engine service uses migration and metadata configuration in

## FAQs

**How can I enable metrics in the the Source Health panel**
**How can I enable metrics in the Source Health panel**

> Currently, only Postgres supports source health check metrics.

Expand Down
Loading