propagate Postgres table comments to GraphQL schema descriptions (close #446) #2397

ajeetdsouza · 2019-06-19T09:59:00Z

Description

The console currently allows a user to add a description to a table via Data > Schema > schema_name > table_name > Modify, but it does not show this description anywhere else. This PR adds descriptions to the GraphQL schema, viewable via the Documentation Explorer:

Affected components

Server

Related Issues

#446

Solution and Design

Descriptions are stored via Postgres comments, viewable in the pg_descriptions table. A descriptions field has been added to the hdb_catalog.hdb_table_info_agg view, and this description is concatenated with the default description when being served to the frontend.

Steps to test and verify

Add a description to any of the tables as described above. It should now be visible in the Documentation Explorer.

Limitations, known bugs & workarounds

None

To the Reviewer (server)

No new modules have been added.
The catalog version has been upgraded to 18. A migration for this has been added (from17To18), which drops the hdb_catalog.hdb_table_info_agg view and recreates it with an added description field.
A newtype PGDescription has been added.
TableInfo now has a new field for descriptions: tiDescription :: Maybe PGDescription.
The following functions now take an extra parameter for table descriptions: mkTableObj, mkGCtxRole, mkGCtxRole'.

Critical files:

src-exec/Migrate.hs
src-lib/Hasura/SQL/Types.hs
src-lib/Hasura/GraphQL/Schema.hs
src-lib/Hasura/RQL/Types/SchemaCache.hs
src-rsr/initialise.sql
src-rsr/migrate_from_17_to_18.sql

hasura-bot · 2019-06-19T09:59:03Z

Beep boop! 🤖

Hey @ajeetdsouza, thanks for your PR!

One of my human friends will review this PR and get back to you as soon as possible. 🕐

Stay awesome! 😎

netlify · 2019-06-19T10:00:26Z

Deploy preview for hasura-docs ready!

Built with commit 458506c

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

hasura-bot · 2019-06-19T10:06:41Z

Review app for commit db9f137 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-db9f137c

server/src-lib/Hasura/RQL/Types/SchemaCache.hs

rakeshkky · 2019-06-20T09:53:01Z

@ajeetdsouza
Can a table have multiple descriptions? If yes, how are you handling them?

ajeetdsouza · 2019-06-20T10:10:57Z

@rakeshkky
Postgres allows only one comment per object, so this won't be a problem: https://www.postgresql.org/docs/current/sql-comment.html

hasura-bot · 2019-07-02T12:31:18Z

Review app for commit 10635b3 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-10635b3f

coco98 · 2019-07-09T07:44:10Z

@ajeetdsouza Why aren't we propagating other comments? Let's just propagate all of them?
I tried column comments, but it doesn't work.

In order of priority, I would say:

Tables
Views
Columns
Functions

hasura-bot · 2019-07-12T07:35:51Z

Review app for commit ac8f9b1 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-ac8f9b12

hasura-bot · 2019-07-12T09:59:57Z

Review app for commit c26324b deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-c26324b7

coco98 · 2019-07-16T20:09:38Z

I don't think this is correct.
I added comments to table/column.
https://hge-ci-pull-2397.herokuapp.com/console/data/schema/public/tables/test/modify

They show up in the wrong place on the graphql docs explorer

hasura-bot · 2019-08-05T10:18:55Z

Review app for commit 06cfe5c deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-06cfe5c1

lexi-lambda

@rakeshkky I think this LGTM, but could I ask you to rebase to resolve the merge conflicts?

…ngine into issue-446-comments

hasura-bot · 2019-08-20T09:03:37Z

Review app for commit e22bebc deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-e22bebc2

Resolve Conflicts: server/src-exec/Migrate.hs server/src-lib/Hasura/GraphQL/Schema.hs server/src-lib/Hasura/GraphQL/Schema/BoolExp.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/Diff.hs server/src-lib/Hasura/RQL/DDL/Schema/Function.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/Common.hs server/src-lib/Hasura/RQL/Types/SchemaCache.hs server/src-rsr/catalog_metadata.sql server/src-rsr/initialise.sql server/src-rsr/migrate_from_19_to_20.sql server/src-rsr/table_meta.sql

hasura-bot · 2019-09-04T09:36:58Z

Review app for commit 8254304 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-8254304c

mastoj · 2019-09-04T11:33:38Z

I still don't believe this to be fixed. I went ahead and created a table and a column on the heroku instance. I can't see the comment I added for the column when I browse through docs.

rakeshkky · 2019-09-04T13:10:40Z

I still don't believe this to be fixed. I went ahead and created a table and a column on the heroku instance. I can't see the comment I added for the column when I browse through docs.

@mastoj Thank you reporting this. This has been fixed in the next commit.

hasura-bot · 2019-09-04T13:17:58Z

Review app for commit 10f2ec0 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-10f2ec06

mastoj · 2019-09-04T13:36:21Z

@rakeshkky nice. Verified that it works.

hasura-bot · 2019-09-13T09:32:34Z

Review app for commit 4c5b326 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-4c5b3266

rakeshkky · 2019-09-13T10:16:43Z

@lexi-lambda Ready to be merged. But please have a final glance. :)

server/src-rsr/migrate_from_22_to_23.sql

hasura-bot · 2019-09-16T06:11:23Z

Review app for commit 4111019 deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-41110199

hasura-bot · 2019-09-16T22:06:13Z

Review app for commit 458506c deployed to Heroku: https://hge-ci-pull-2397.herokuapp.com
Docker image for server: hasura/graphql-engine:pull2397-458506c6

hasura-bot · 2019-09-17T01:51:13Z

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

hasura#446) (hasura#2397)

Add Postgres comments to table descriptions

db9f137

ajeetdsouza added the c/server Related to server label Jun 19, 2019

ajeetdsouza requested a review from rakeshkky June 19, 2019 09:59

ajeetdsouza requested a review from 0x777 as a code owner June 19, 2019 09:59

ajeetdsouza self-assigned this Jun 19, 2019

shahidhk mentioned this pull request Jun 20, 2019

propagate comments from sql to graphql schema #446

Closed

rakeshkky changed the title ~~Add Postgres comments to table descriptions (close #446)~~ propagate Postgres table comments to GraphQL schema descriptions (close #446) Jun 20, 2019

rakeshkky reviewed Jun 20, 2019

View reviewed changes

server/src-lib/Hasura/RQL/Types/SchemaCache.hs Outdated Show resolved Hide resolved

rakeshkky reviewed Jun 20, 2019

View reviewed changes

server/src-lib/Hasura/RQL/Types/SchemaCache.hs Outdated Show resolved Hide resolved

Create newtype for PGDescription

e1a9bd0

rakeshkky previously approved these changes Jul 2, 2019

View reviewed changes

Merge branch 'master' into issue-446-comments

10635b3

ajeetdsouza added 2 commits July 11, 2019 17:15

update cache on change in comment

4a9a261

move table comments in API explorer

ac8f9b1

ajeetdsouza dismissed rakeshkky’s stale review via ac8f9b1 July 12, 2019 07:28

add Postgres comments to function description

c26324b

dsandip assigned rakeshkky and unassigned ajeetdsouza Jul 23, 2019

Merge branch 'master' into issue-446-comments

9dc8a97

rakeshkky requested a review from lexi-lambda as a code owner July 23, 2019 11:51

lexi-lambda previously approved these changes Aug 16, 2019

View reviewed changes

dsandip added this to the beta.5 milestone Aug 19, 2019

rakeshkky added 2 commits August 20, 2019 14:22

Merge branch 'master' into issue-446-comments

4af9f9b

Merge branch 'issue-446-comments' of github.com:ajeetdsouza/graphql-e…

e22bebc

…ngine into issue-446-comments

rakeshkky dismissed lexi-lambda’s stale review via e22bebc August 20, 2019 08:54

dsandip removed this from the beta.5 milestone Sep 4, 2019

ajeetdsouza requested a review from rikinsk as a code owner September 4, 2019 09:28

fix table descriptions are not capturing

10f2ec0

lorenzo reviewed Sep 13, 2019

View reviewed changes

server/src-rsr/migrate_from_22_to_23.sql Outdated Show resolved Hide resolved

rakeshkky added 2 commits September 16, 2019 11:03

Merge branch 'master' into issue-446-comments

64dfe20

fix typo 'psuedo'; rename it to 'pseudo' in server code

4111019

Merge branch 'master' into issue-446-comments

458506c

lexi-lambda approved these changes Sep 16, 2019

View reviewed changes

lexi-lambda merged commit 99174cc into hasura:master Sep 17, 2019

polRk pushed a commit to polRk/graphql-engine that referenced this pull request Feb 12, 2020

propagate Postgres table comments to GraphQL schema descriptions (close

cff454e

hasura#446) (hasura#2397)

lummish mentioned this pull request Nov 26, 2020

Computed Field Comments Do Not Propagate to GraphQL Schema Descriptions #6256

Closed

rocketraman mentioned this pull request May 28, 2021

Allow table comments to describe the schema type #6997

Closed

propagate Postgres table comments to GraphQL schema descriptions (close #446) #2397

propagate Postgres table comments to GraphQL schema descriptions (close #446) #2397

Uh oh!

Conversation

ajeetdsouza commented Jun 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Affected components

Related Issues

Solution and Design

Steps to test and verify

Limitations, known bugs & workarounds

To the Reviewer (server)

Uh oh!

hasura-bot commented Jun 19, 2019

Uh oh!

netlify bot commented Jun 19, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hasura-bot commented Jun 19, 2019

Uh oh!

Uh oh!

Uh oh!

rakeshkky commented Jun 20, 2019

Uh oh!

ajeetdsouza commented Jun 20, 2019

Uh oh!

hasura-bot commented Jul 2, 2019

Uh oh!

coco98 commented Jul 9, 2019

Uh oh!

hasura-bot commented Jul 12, 2019

Uh oh!

hasura-bot commented Jul 12, 2019

Uh oh!

coco98 commented Jul 16, 2019

Uh oh!

hasura-bot commented Aug 5, 2019

Uh oh!

lexi-lambda left a comment

Choose a reason for hiding this comment

Uh oh!

hasura-bot commented Aug 20, 2019

Uh oh!

hasura-bot commented Sep 4, 2019

Uh oh!

mastoj commented Sep 4, 2019

Uh oh!

rakeshkky commented Sep 4, 2019

Uh oh!

hasura-bot commented Sep 4, 2019

Uh oh!

mastoj commented Sep 4, 2019

Uh oh!

hasura-bot commented Sep 13, 2019

Uh oh!

rakeshkky commented Sep 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

hasura-bot commented Sep 16, 2019

Uh oh!

hasura-bot commented Sep 16, 2019

Uh oh!

hasura-bot commented Sep 17, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

ajeetdsouza commented Jun 19, 2019 •

edited

Loading

netlify bot commented Jun 19, 2019 •

edited

Loading

rakeshkky commented Sep 13, 2019 •

edited

Loading