allow customising graphql schema for a table (close #981) #2509

rakeshkky · 2019-07-11T07:39:50Z

Requires merging hasura/graphql-parser-hs#17

TODO:-

Add tests
Add docs
Console integration

Description

Allow users to customize root field names of a Postgres table and column fields in GraphQL schema. However, original Postgres column names are used to define metadata such as relationships, permissions etc.

Default root field names generated for a table author are:

Queries:-

author
author_by_pk
author_aggregate

Mutations:-

insert_author
delete_author
update_author

TODO:- insert UI screenshots after console work is done.

Note:- Only root field names and columns are customizable as of now. I'm open to any request for customizing other parts of Hasura generated GraphQL schema

Affected components

Server
Console
Docs
Tests

Related Issues

#981

Solution and Design

A new optional version field whose type is Int is introduced in /v1/query payload which specifies
the version of the query. If absent version is considered as 1. All existing query types come under version: 1

track_table query type is supported in version: 2.

Example:-

POST /v1/query

{
    "type": "track_table",
    "version": 2,
    "args": {
        "table": "user",
        "configuration": {
            "custom_root_fields": {
                "select": "Users",
                "select_by_pk": "User",
                "select_aggregate": "UserAggregate",
                "insert": "AddUsers",
                "update": "UpdateUsers",
                "delete": "DeleteUsers"
            },
            "custom_column_names": {
            	"id": "userId"
            }
        }
    }
}

A new set_table_custom_fields query type is added in version: 2. It is used to update the custom field names of an already tracked table.

Example:-

POST /v1/query

{
  "type": "set_table_custom_fields",
  "version": 2,
  "args": {
    "table": "author",
    "custom_root_fields": {
      "select": "Authors",
      "select_by_pk": "Author"
    },
    "custom_column_names": {
      "id": "AuthorId",
      "name": "AuthorName"
    }
  }
}

Catalog changes:-

A new nullable column configuration of type JSONB is added to table
hdb_catalog.hdb_table which stores the configuration JSON object found in track_table v2 query.

For Console:

Refer docs to learn more about new track_table version 2 API.

NOTE: Tracking an already tracked table using version 2 track_table API won't throw API exception, instead it'll update the configuration in metadata cache and catalog.

Steps to test and verify

Limitations, known bugs & workarounds

Resolve Conflicts: server/src-lib/Hasura/Server/App.hs server/src-lib/Hasura/Server/Utils.hs

netlify · 2019-07-11T07:41:18Z

Deploy preview for hasura-docs ready!

Built with commit 6309ce5

https://deploy-preview-2509--hasura-docs.netlify.com

hasura-bot · 2019-07-11T07:47:36Z

Review app for commit a19496d deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-a19496db

ecthiender · 2019-07-11T08:50:55Z

@rakeshkky @0x777 why aren't we doing /v2/query instead of the version key in the payload? It seems to defeat the purpose of having a versioned endpoint.

0x777 · 2019-07-11T09:01:14Z

@ecthiender If you have a separate endpoint /v2/query you won't be able to mix v1 and v2 queries in a single bulk query. Also the version in /v1/query would change if something fundamental changes, like the structure changes from type and args and also version key can be introduced alongside type, args in a backwards compatible way.

Resolve Conflicts: server/src-lib/Hasura/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/RQL/Types/Common.hs

rakeshkky · 2019-07-12T10:04:02Z

As of now, the only way to update configuration of a table is to untrack and track table with the updated configuration. We lose all permissions and relationships of the table.

I have a plan to add update_table_configuration query type which will update the configuration of a table. If I add, what should be the version of that query?

@0x777 @ecthiender @shahidhk thoughts?

hasura-bot · 2019-07-12T10:21:06Z

Review app for commit 48032f7 deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-48032f7f

shahidhk · 2019-07-15T10:21:55Z

I have a plan to add update_table_configuration query type which will update the configuration of a table. If I add, what should be the version of that query?

It would be version nil (or 1) ideally, but if the code is easier managed if the version is 2, go ahead with 2.

Resolve Conflicts: server/src-exec/Migrate.hs server/src-lib/Hasura/RQL/Types/SchemaCache.hs server/src-lib/Hasura/Server/App.hs server/src-lib/Hasura/Server/Query.hs

hasura-bot · 2019-07-29T12:31:37Z

Review app for commit e0a5f4b deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-e0a5f4bf

hasura-bot · 2019-07-30T12:12:36Z

Review app for commit c8e1452 deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-c8e14524

hasura-bot · 2019-09-09T07:12:58Z

Review app for commit 6b00fec deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-6b00fecf

Resolve Conflicts: server/src-lib/Hasura/Server/Utils.hs

hasura-bot · 2019-09-09T08:22:48Z

Review app for commit 7ffb524 deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-7ffb5246

Resolve Conflicts: docs/graphql/manual/api-reference/schema-metadata-api/index.rst

hasura-bot · 2019-09-11T12:25:56Z

Review app for commit 75f250e deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-75f250ee

hasura-bot · 2019-09-13T13:07:28Z

Review app for commit 5973e2f deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-5973e2f9

Resolve Conflicts: server/src-exec/Migrate.hs server/src-lib/Hasura/GraphQL/Resolve/Insert.hs server/src-lib/Hasura/GraphQL/Resolve/Mutation.hs server/src-lib/Hasura/GraphQL/Resolve/Select.hs server/src-lib/Hasura/GraphQL/Schema.hs server/src-lib/Hasura/GraphQL/Schema/BoolExp.hs server/src-lib/Hasura/GraphQL/Schema/Common.hs server/src-lib/Hasura/GraphQL/Schema/Mutation/Common.hs server/src-lib/Hasura/GraphQL/Schema/Select.hs server/src-lib/Hasura/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/RQL/DML/Internal.hs server/src-lib/Hasura/RQL/DML/Returning.hs server/src-lib/Hasura/RQL/GBoolExp.hs server/src-lib/Hasura/RQL/Types/Column.hs

rakeshkky · 2019-09-18T12:35:45Z

@lexi-lambda Please have a final glance. Suggest the changes if any.

hasura-bot · 2019-09-18T12:44:31Z

Review app for commit 6309ce5 deployed to Heroku: https://hge-ci-pull-2509.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2509-6309ce5d

shahidhk

LGTM

shahidhk · 2019-09-19T04:47:13Z

I am guessing console changes are going out as a separate PR

hasura-bot · 2019-09-19T04:47:39Z

Review app https://hge-ci-pull-2509.herokuapp.com is deleted

…ra#2509) * allow customizing GraphQL root field names, close hasura#981 * document v2 track_table API in reference * support customising column field names in GraphQL schema * [docs] add custom column fields doc in API reference * add tests * rename 'ColField' to 'ColumnField' * embed column's graphql field in 'PGColumnInfo' -> Value constructor of 'PGCol' is not exposed -> Using 'parseJSON' to construct 'PGCol' in 'FromJSON' instances * avoid using 'Maybe TableConfig' * refactors & 'custom_column_fields' -> 'custom_column_names' * cli-test: add configuration field in metadata export test * update expected keys in `FromJSON` instance of `TableMeta` * use `buildSchemaCacheFor` to update configuration in v2 track_table * remove 'GraphQLName' type and use 'isValidName' exposed from parser lib * point graphql-parser-hs library git repo to hasura * support 'set_table_custom_fields' query API & added docs and tests

rakeshkky added 3 commits July 10, 2019 14:08

allow customizing GraphQL root field names, close hasura#981

813f951

Merge branch 'master' into issue-981-custom-graphql

b4c1236

Merge branch 'master' into issue-981-custom-graphql

a19496d

Resolve Conflicts: server/src-lib/Hasura/Server/App.hs server/src-lib/Hasura/Server/Utils.hs

rakeshkky added s/do-not-merge Do not merge this pull request to master c/console Related to console c/server Related to server c/docs Related to docs labels Jul 11, 2019

rakeshkky requested a review from 0x777 as a code owner July 11, 2019 07:39

rakeshkky self-assigned this Jul 11, 2019

rakeshkky added 2 commits July 12, 2019 13:50

Merge branch 'master' into issue-981-custom-graphql

12b5230

Resolve Conflicts: server/src-lib/Hasura/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/RQL/Types/Common.hs

document v2 track_table API in reference

48032f7

shahidhk changed the title ~~allow customising GraphQL root fields of a Table (close #981)~~ Allow customising GraphQL root fields of a Table (close #981) Jul 15, 2019

rakeshkky changed the title ~~Allow customising GraphQL root fields of a Table (close #981)~~ add customising GraphQL root fields of a Table (close #981) Jul 23, 2019

rakeshkky changed the title ~~add customising GraphQL root fields of a Table (close #981)~~ allow customising GraphQL root fields of a Table (close #981) Jul 23, 2019

rakeshkky added 3 commits July 23, 2019 17:49

Merge branch 'master' into issue-981-custom-graphql

4d065c2

support customising column field names in GraphQL schema

2adf949

Merge branch 'master' into issue-981-custom-graphql

e0a5f4b

Resolve Conflicts: server/src-exec/Migrate.hs server/src-lib/Hasura/RQL/Types/SchemaCache.hs server/src-lib/Hasura/Server/App.hs server/src-lib/Hasura/Server/Query.hs

rakeshkky requested review from lexi-lambda and marionschleifer as code owners July 29, 2019 12:17

marionschleifer mentioned this pull request Jul 29, 2019

docs: document table_by_pk query #2047

Closed

Merge branch 'master' into issue-981-custom-graphql

c8e1452

Merge branch 'master' into issue-981-custom-graphql

7ffb524

Resolve Conflicts: server/src-lib/Hasura/Server/Utils.hs

rakeshkky added 2 commits September 11, 2019 17:29

remove 'GraphQLName' type and use 'isValidName' exposed from parser lib

19116b5

Merge branch 'master' into issue-981-custom-graphql

75f250e

Resolve Conflicts: docs/graphql/manual/api-reference/schema-metadata-api/index.rst

marionschleifer previously approved these changes Sep 12, 2019

View reviewed changes

point graphql-parser-hs library git repo to hasura

d3f60eb

rakeshkky dismissed marionschleifer’s stale review via dc67263 September 13, 2019 12:44

support 'set_table_custom_fields' query API & added docs and tests

5973e2f

rakeshkky force-pushed the issue-981-custom-graphql branch from dc67263 to 5973e2f Compare September 13, 2019 12:52

marionschleifer approved these changes Sep 18, 2019

View reviewed changes

lexi-lambda approved these changes Sep 18, 2019

View reviewed changes

shahidhk changed the title ~~allow customising GraphQL root fields of a Table (close #981)~~ allow customising graphql root fields of a table (close #981) Sep 19, 2019

shahidhk changed the title ~~allow customising graphql root fields of a table (close #981)~~ allow customising graphql schema generated for a table (close #981) Sep 19, 2019

shahidhk approved these changes Sep 19, 2019

View reviewed changes

shahidhk changed the title ~~allow customising graphql schema generated for a table (close #981)~~ allow customising graphql schema for a table (close #981) Sep 19, 2019

shahidhk merged commit 9bd5826 into hasura:master Sep 19, 2019

dsandip removed the s/do-not-merge Do not merge this pull request to master label Sep 20, 2019

rakeshkky mentioned this pull request Sep 24, 2019

update custom column names on renaming/dropping columns #2933

Merged

tirumaraiselvan mentioned this pull request Oct 8, 2019

Besides the remote schema method, is it also possible to add apollo-server-express on top of hasura to extend the functions? #3057

Closed

rorhug mentioned this pull request Oct 14, 2019

New custom field API odd behaviour #3137

Closed

rakeshkky mentioned this pull request Oct 25, 2019

Why is Hasura erring on startup with “following root fields are duplicated” in beta8? #3220

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow customising graphql schema for a table (close #981) #2509

allow customising graphql schema for a table (close #981) #2509

rakeshkky commented Jul 11, 2019 •

edited

Loading

netlify bot commented Jul 11, 2019 •

edited

Loading

hasura-bot commented Jul 11, 2019

ecthiender commented Jul 11, 2019

0x777 commented Jul 11, 2019

rakeshkky commented Jul 12, 2019

hasura-bot commented Jul 12, 2019

shahidhk commented Jul 15, 2019

hasura-bot commented Jul 29, 2019

hasura-bot commented Jul 30, 2019

hasura-bot commented Sep 9, 2019

hasura-bot commented Sep 9, 2019

hasura-bot commented Sep 11, 2019

hasura-bot commented Sep 13, 2019

rakeshkky commented Sep 18, 2019

hasura-bot commented Sep 18, 2019

shahidhk left a comment

shahidhk commented Sep 19, 2019

hasura-bot commented Sep 19, 2019

allow customising graphql schema for a table (close #981) #2509

allow customising graphql schema for a table (close #981) #2509

Conversation

rakeshkky commented Jul 11, 2019 • edited Loading

Description

Affected components

Related Issues

Solution and Design

For Console:

Steps to test and verify

Limitations, known bugs & workarounds

netlify bot commented Jul 11, 2019 • edited Loading

hasura-bot commented Jul 11, 2019

ecthiender commented Jul 11, 2019

0x777 commented Jul 11, 2019

rakeshkky commented Jul 12, 2019

hasura-bot commented Jul 12, 2019

shahidhk commented Jul 15, 2019

hasura-bot commented Jul 29, 2019

hasura-bot commented Jul 30, 2019

hasura-bot commented Sep 9, 2019

hasura-bot commented Sep 9, 2019

hasura-bot commented Sep 11, 2019

hasura-bot commented Sep 13, 2019

rakeshkky commented Sep 18, 2019

hasura-bot commented Sep 18, 2019

shahidhk left a comment

Choose a reason for hiding this comment

shahidhk commented Sep 19, 2019

hasura-bot commented Sep 19, 2019

rakeshkky commented Jul 11, 2019 •

edited

Loading

netlify bot commented Jul 11, 2019 •

edited

Loading