Make function 8000 return types nullable #480
Conversation
I wonder if there's a way to force postgres to throw an error when such functions are defined? If a function returns a column that is marked as not nullable, it's a bit confusing to have a nullable function return type. |
@psteinroe contributed a change which adds schema functions which take only the table name as columns on the tables when generating TypeScript types. This commit extends that to treat function return types as nullable. The function used in `oo-init.sql` could be changed like so: ```sql create function public.blurb(public.todos) returns text as $$ select null; $$ language sql stable; ``` It would still compile and be a valid function despite the unchanged return type, which means any function must be treated as potentially returning `null` in the types. I have also updated instructions for building and testing the TypeScript type generation.
|
Thanks for the fix!
It's not really a column - it's a regular function that takes a table's row type as the argument, so the nullability information isn't stored anywhere. We only treat them as columns because PostgREST exposes them as if they were (generated) columns. There's also the actual generated columns - that should be preferred since that fulfills the same purpose and AFAIK allows you to set nullability. |
|
🎉 This PR is included in version 0.60.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
psteinroe contributed a change which adds schema functions which take only the table name as columns on the tables when generating TypeScript types. This commit extends that to treat function return types as nullable. The function used in `oo-init.sql` could be changed like so: ```sql create function public.blurb(public.todos) returns text as $$ select null; $$ language sql stable; ``` It would still compile and be a valid function despite the unchanged return type, which means any function must be treated as potentially returning `null` in the types. I have also updated instructions for building and testing the TypeScript type generation.
What kind of change does this PR introduce?
Makes all table function column return types nullable.
What is the current behavior?
The verbatim function types are used as column types despite the functions potentially returning
null.What is the new behavior?
All return types are treated as nullable.
Additional context
@psteinroe contributed a change which adds schema functions which take only the table name as columns on the tables when generating TypeScript types.
This commit extends that to treat function return types as nullable.
The function used in
oo-init.sqlcould be changed like so:It would still compile and be a valid function despite the unchanged return type, which means any function must be treated as potentially returning
nullin the types.I have also updated instructions for building and testing the TypeScript type generation.
Here's how I tested this:
npm installandnpm run devto spin up the Docker container and the code watchernpm run gen:types:typescriptto hit the endpoint that generates the TypeScript typessrc/server/templates/typescript.tsand re-run the above