Skip to content

Describe smart comment support for Enum Types #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benjie merged 1 commit into from
Mar 23, 2021
Merged

Describe smart comment support for Enum Types #267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/pages/postgraphile/enums.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ create table pets (
);
```

The `@enum` smart comments can be used to set the name (`@enumName`)
or the description (`@enumDescription`) of PostgreSQL enums.

e.g.:
```sql
COMMENT ON TYPE animal_type IS E'@enum\n@enumName TypeOfAnimal';
```

Sometimes people prefer not to use PostgreSQL enums due to their technical
limitations (e.g. you can never drop a value from a PostgreSQL enum, and you
cannot add a value to it within a transaction). There are other ways to add
Expand Down