postgres functions as custom queries (close #333) #1073

rakeshkky · 2018-11-20T13:20:08Z

Description

What component does this PR affect?

Requires changes from other components? If yes, please mark the components:

Related Issue

close #333

Solution and Design

For table article.

create table article (id serial primary key, title text not null, content text not null, author_id integer not null)

Define a function search_articles as following:-

      create function search_articles(search text)
      returns setof article as $$
          select *
          from article
          where
          title ilike ('%' || search || '%') or
          content ilike ('%' || search || '%')
      $$ language sql stable;

Then GraphQL Engine generates custom query field on search_articles :-

search_articles(
args: search_articles_args! 
where: artcle_bool_exp
order_by: [article_order_by!] 
limit: Int
offset: Int
): [article!]! 

input search_article_args {
search: String!
}

Sample GraphQL query:-

query search_articles {
  search_articles(
    args: {search: "Hasura"}
  ){
    id
    title
    content
    author_id
  }
}

Metadata API:-

Adding a function

   POST /v1/query HTTP/1.1
   Content-Type: application/json
   X-Hasura-Role: admin

   {
       "type": "track_function",
       "args": {
           "schema": "public",
           "name": "search_articles"
       }
   }

Removing a function

   POST /v1/query HTTP/1.1
   Content-Type: application/json
   X-Hasura-Role: admin

   {
       "type": "untrack_function",
       "args": {
           "schema": "public",
           "name": "search_articles"
       }
   }

Type

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Docs update
Community content

Checklist:

I have read the contributing guide and my code conforms to the guidelines.
This change requires a change in the documentation.
I have updated the documentation accordingly.
I have added required tests.

TODO:- -> functions as mutations -> permissions -> tests

Resolve Conflicts: console/src/components/Services/Data/Metadata/Metadata.js server/src-exec/Ops.hs server/src-lib/Hasura/GraphQL/Resolve.hs server/src-lib/Hasura/GraphQL/Resolve/BoolExp.hs server/src-lib/Hasura/GraphQL/Resolve/Select.hs server/src-lib/Hasura/GraphQL/Schema.hs server/src-lib/Hasura/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/SQL/DML.hs server/src-lib/Hasura/SQL/Types.hs server/src-lib/Hasura/Server/Query.hs server/tests-py/test_graphql_queries.py

Resolve Conflicts: server/src-lib/Hasura/GraphQL/Resolve/Mutation.hs server/src-lib/Hasura/GraphQL/Resolve/Select.hs

Resolve Conflicts: server/src-exec/Ops.hs server/src-lib/Hasura/GraphQL/Resolve/BoolExp.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/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/RQL/Types/SchemaCache.hs

hasura-bot · 2018-11-20T14:10:12Z

Review app available at: https://hge-ci-pull-1073.herokuapp.com

hasura-bot · 2018-11-20T17:18:19Z

Review app available at: https://hge-ci-pull-1073.herokuapp.com

revskill10 · 2018-11-22T08:36:55Z

How about sql function as mutation ?

shahidhk · 2018-11-23T05:37:00Z

@revskill10 We'll add them in the coming iterations.

Resolve Conflicts: server/src-exec/Ops.hs server/src-exec/TH.hs server/src-lib/Hasura/GraphQL/Resolve/Context.hs server/src-lib/Hasura/GraphQL/Schema.hs server/src-lib/Hasura/Prelude.hs server/src-lib/Hasura/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/RQL/DML/Select.hs server/src-lib/Hasura/RQL/Types/SchemaCache.hs server/src-lib/Hasura/Server/App.hs server/src-lib/Hasura/Server/Query.hs server/src-rsr/hdb_metadata.yaml server/src-rsr/initialise.sql

revskill10 · 2018-11-25T18:51:11Z

So as i see, there won't be a subscription for the same query with custom sql function ?
e.g

subscription search_articles {
  search_articles(
    args: {search: "Hasura"}
  ){
    id
    title
    content
    author_id
  }
}

rakeshkky · 2018-11-26T07:30:24Z

@revskill10 Subscription allows custom queries as well.

hasura-bot · 2018-11-26T10:57:00Z

Review app for commit ee4d7e3 deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-ee4d7e3

jasonmorganson · 2018-12-12T21:40:41Z

@rakeshkky this would be a really useful feature. Any idea on when this will land?

shahidhk · 2018-12-14T10:10:12Z

@jasonmorganson This should take another week or two.

Resolve Conflicts: server/src-exec/Ops.hs server/src-exec/TH.hs server/src-lib/Hasura/GraphQL/Context.hs server/src-lib/Hasura/GraphQL/Resolve/Select.hs server/src-lib/Hasura/GraphQL/Schema.hs server/src-lib/Hasura/Prelude.hs server/src-lib/Hasura/RQL/DDL/Schema/Table.hs server/src-lib/Hasura/RQL/DML/Select.hs server/src-lib/Hasura/Server/Query.hs server/src-rsr/migrate_from_5_to_6.sql

hasura-bot · 2019-01-21T15:03:42Z

Review app for commit 5027a8c deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-5027a8c

0x777 · 2019-01-22T07:57:55Z

server/src-lib/Hasura/RQL/DDL/Schema/Function.hs

+                     => QualifiedFunction -> m ()
+trackFunctionP2Setup qf = do
+  fi <- withPathK "name" $ liftTx $ getFunctionInfo qf
+  void $ askTabInfo $ fiReturnType fi


Is this to check if the return table is tracked? If so, it should catch the error and return a more useful error message along these lines: "the return table: tname has to be tracked before the function can be tracked"

hasura-bot · 2019-01-22T08:48:59Z

Review app for commit 4fae992 deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-4fae992

-> now fetch 'returns_table' bool value in 'raw_function_info' SQL -> move 'raw_function_info' fetch SQL to separate file (src-rsr/function_info.sql) -> throw "table <table-name> is not tracked" error message

hasura-bot · 2019-01-22T11:40:36Z

Review app for commit a22808e deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-a22808e

hasura-bot · 2019-01-24T09:08:44Z

Review app for commit f2d8a54 deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-f2d8a54

console/src/components/Services/Data/Function/Modify/ModifyCustomFunction.js

console/src/components/Services/Data/Function/customFunctionReducer.js

console/src/components/Services/Data/RawSQL/RawSQL.js

console/src/helpers/semver.js

hasura-bot · 2019-01-24T15:59:18Z

Review app for commit f068d2f deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-f068d2f

hasura-bot · 2019-01-24T19:57:12Z

Review app for commit 0b00abf deployed to Heroku: https://hge-ci-pull-1073.herokuapp.com
Docker image for server: hasura/graphql-engine:pull1073-0b00abf

hasura-bot · 2019-01-25T03:31:56Z

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

Bumps [serde_json](https://github.com/serde-rs/json) from 1.0.127 to 1.0.128. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/serde-rs/json/releases">serde_json's releases</a>.</em></p> <blockquote> <h2>1.0.128</h2> <ul> <li>Support serializing maps containing 128-bit integer keys to serde_json::Value (<a href="https://redirect.github.com/serde-rs/json/issues/1188">#1188</a>, thanks <a href="https://github.com/Mrreadiness"><code>@Mrreadiness</code></a>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/serde-rs/json/commit/d96b1d9b643b49a0bb92a8cf280daf6aa08f37cc"><code>d96b1d9</code></a> Release 1.0.128</li> <li><a href="https://github.com/serde-rs/json/commit/599228d5dc52a0f1595fe4bd901821f70d0317a5"><code>599228d</code></a> Merge pull request <a href="https://redirect.github.com/serde-rs/json/issues/1188">#1188</a> from Mrreadiness/feat/add-hashmap-key-128-serializer</li> <li><a href="https://github.com/serde-rs/json/commit/5416cee6c5ad355907f6e9d5f6039b994c69f768"><code>5416cee</code></a> feat: add support for 128 bit HashMap key serialization</li> <li><a href="https://github.com/serde-rs/json/commit/27a4ca9d7a62394fe8f0103f3d91de59f055a4c4"><code>27a4ca9</code></a> Upload CI Cargo.lock for reproducing failures</li> <li>See full diff in <a href="https://github.com/serde-rs/json/compare/1.0.127...1.0.128">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=serde_json&package-manager=cargo&previous-version=1.0.127&new-version=1.0.128)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> V3_GIT_ORIGIN_REV_ID: c6df67f3a862c0eabd372688d42c4b68ca56a939

rakeshkky added 11 commits September 22, 2018 17:13

sql functions as queries

555ddc7

TODO:- -> functions as mutations -> permissions -> tests

handle overloaded functions, add basic test

ebcba17

Merge branch 'master' into issue-333

38fb005

fix test yaml

ac8e425

improve function args generation and resolving logic

2a44190

Merge branch 'master' into issue-333

32f2dd5

Resolve Conflicts: server/src-lib/Hasura/GraphQL/Resolve/Mutation.hs server/src-lib/Hasura/GraphQL/Resolve/Select.hs

add 'function_definition' column in 'hdb_function_agg' view

0af6c81

apply table's boolean permission on functions

123b3c9

allow aggregations on function queries

e85dfe7

rakeshkky requested a review from 0x777 November 20, 2018 13:20

fix drop function

683db2e

shahidhk added c/server Related to server c/docs Related to docs labels Nov 21, 2018

console 'passCreateForeignKey' test to wait for 1 second

ee4d7e3

haasel77 mentioned this pull request Jan 3, 2019

expose postgres functions as queries and mutations #333

Closed

rakeshkky added 3 commits January 4, 2019 17:56

improve function info fetching SQL and function_agg view

e329a0e

check for graphql schema conflicts while tracking a function

98d9855

0x777 reviewed Jan 22, 2019

View reviewed changes

check function name and argument names for GraphQL compliance

4fae992

improve function info fetching and validation logic

f159291

-> now fetch 'returns_table' bool value in 'raw_function_info' SQL -> move 'raw_function_info' fetch SQL to separate file (src-rsr/function_info.sql) -> throw "table <table-name> is not tracked" error message

0x777 previously approved these changes Jan 22, 2019

View reviewed changes

Merge branch 'master' into issue-333

a22808e

karthikvt26 dismissed 0x777’s stale review via f2d8a54 January 24, 2019 08:36

Merge remote-tracking branch 'main/master' into issue-333

f2d8a54