Support for UDFs as GraphQL queries/mutations #393

imor · 2023-07-24T11:53:05Z

What kind of change does this PR introduce?

New feature and docs update.

What is the current behavior?

User defined functions are not available through GraphQL.

What is the new behavior?

User defined functions are available as fields on the query and mutation root types.

Additional context

Tasks

Add support for base types:

Add UDF metadata to sql context.
Expose UDFs in introspection schema.
Parse UDF fields on mutation and query objects.
Transpile & execute UDF field requests.
Add tests

Add support for composite types:

Add UDF metadata to sql context.
Expose UDFs in introspection schema.
Parse UDF fields on mutation and query objects.
Transpile & execute UDF field requests.
Add tests

Misc:

Remove tables->functions key and use the new functions in sql context for columns extended with functions.
Handle function name clashes with other fields. E.g. if there is a table named account and a function named accountCollection.
Accept args for function which return a single table row.
Add support for argument name inflection.
Update docs.

Resolves #222

The test failed because a function of type char(x) was being cast to `character` instead of `char(x)`. This was because when we load the sql context we do not have the type modifier info to find out what `x` in char(`x`) is for function inputs. As a workaround we cast such vales to text instead.

imor · 2023-09-06T12:34:02Z

this looks really great. the asks would be:

Add in the return type transforms so e.g. bigint gets returned as as string and json as an escaped json string

Filter out the functions that aren't supported yet rather than leaving their behavior as undefined

+1 on your API design decisions

In case you hadn't seen these, good reading: https://www.graphile.org/postgraphile/functions/ https://www.graphile.org/postgraphile/custom-mutations/

Yeah, I have read these. Actually these pages influenced a lot of the design choices for our implementation.

src/transpile.rs

test/sql/function_calls.sql

test/expected/function_calls.out

If a function returning Node returned null, it output a row with every field as null rather than a null top level object.

src/graphql.rs

Filter function accessibility by role on execute privilege + test

This reverts commit 88b1bb5.

…s properly" This reverts commit 3ff3598.

…turns null

imor added 30 commits July 24, 2023 17:00

add udfs to sql context

8f6210d

expose UDFs in introspection schema

99ec433

only use VOLATILE functions in mutation

728bdb1

simple function calls working on mutation object

17b9645

remove commented out code

638a3cd

add a test to call a function on muation

ce8bdce

make volatile explicit

c7f6eae

add another test

a84f1de

add bigints test

2dbeb23

add bools test

cfcf0c3

add reals test

1d0f1f3

add double precision test

0ffe4ca

add numerics test

3494614

add uuid test

3c1d7ef

add text test

1747b8a

fix eof

86127b9

add date test

9cd153c

add time test

5f31923

add time with time zone test

5d9f0ed

add timestamp test

bc69df4

add timestamptz test and using fixed timezone

a0b0c1d

add json test

c661f69

add jsonb test

74ec2b5

add failing char(x) test

dc7cb45

add varchar(x) test

a1c5cdc

extract a function for function fields

174fd69

expose stable/immutable funcs on query type

0c870b0

Merge branch 'master' into expose_udfs

be4e577

Merge branch 'master' into expose_udfs

8d7aec5

imor added 6 commits September 6, 2023 17:06

filter out functions with nameless args

05730d6

compute function_name_to_count only once

5b8cb79

filter out functions with default args

67d0eed

update comments in unsupported functions tests

717ad18

filter out functions accepting or returning array types

a99f9a3

fix trailing whitespace

7216d75

imor requested a review from olirice September 7, 2023 02:41

olirice requested changes Sep 8, 2023

View reviewed changes

src/transpile.rs Outdated Show resolved Hide resolved

test/sql/function_calls.sql Outdated Show resolved Hide resolved

test/expected/function_calls.out Outdated Show resolved Hide resolved

imor added 2 commits September 14, 2023 13:29

fix a function not being excluded in a test

07afef4

fix a bug in which Node returning function didn't handle nulls properly

3ff3598

If a function returning Node returned null, it output a row with every field as null rather than a null top level object.

imor requested a review from olirice September 14, 2023 10:56

remove a stray comment

88b1bb5

olirice reviewed Sep 18, 2023

View reviewed changes

src/graphql.rs Show resolved Hide resolved

olirice and others added 8 commits September 19, 2023 09:48

filter function accessibility by role on execute privilege + test

4a36544

Merge pull request #1 from supabase/or/function-execute-test

63484ea

Filter function accessibility by role on execute privilege + test

Revert "remove a stray comment"

4c0bcfa

This reverts commit 88b1bb5.

Revert "fix a bug in which Node returning function didn't handle null…

4320620

…s properly" This reverts commit 3ff3598.

Merge branch 'master' into expose_udfs

13bd773

bump pgrx version to 0.10.2

27ea219

Merge branch 'bump_pgrx_version' into expose_udfs

ab54284

return null root object install of all null fields when a function re…

4e0f471

…turns null

imor requested a review from olirice September 26, 2023 06:20

olirice added 3 commits September 26, 2023 13:02

add QueryType and MutationType to function docs

11690c8

test arg and return types not on search path are filtered out

e823810

update changelog

fbdcb2b

olirice approved these changes Sep 26, 2023

View reviewed changes

olirice merged commit e81046c into supabase:master Sep 26, 2023
4 checks passed

imor deleted the expose_udfs branch September 27, 2023 06:22

imor mentioned this pull request Oct 23, 2023

UDF call returns null #439

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for UDFs as GraphQL queries/mutations #393

Support for UDFs as GraphQL queries/mutations #393

imor commented Jul 24, 2023 •

edited

imor commented Sep 6, 2023 •

edited

Support for UDFs as GraphQL queries/mutations #393

Support for UDFs as GraphQL queries/mutations #393

Conversation

imor commented Jul 24, 2023 • edited

What kind of change does this PR introduce?

What is the current behavior?

What is the new behavior?

Additional context

Tasks

imor commented Sep 6, 2023 • edited

imor commented Jul 24, 2023 •

edited

imor commented Sep 6, 2023 •

edited