Skip to content
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.

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

Conflicting / missing information on enums #238

Open
BillyWM opened this issue Aug 6, 2022 · 1 comment
Open

Conflicting / missing information on enums #238

BillyWM opened this issue Aug 6, 2022 · 1 comment

Comments

@BillyWM
Copy link

BillyWM commented Aug 6, 2022

Issue Creation Checklist

[x] I have read the contribution guidelines

Issue Description

What was unclear/insufficient/not covered in the documentation

The docs, under "Other Data Types", don't mention that enums are Postgres only, but the API reference does. Since "Other Data Types" calls out a number of features that are dialect-specific, the omission of this info leads one to assume that enums are supported across all dialects (somehow)

If possible: Provide some suggestion on how we can enhance the docs

If enums are indeed only supported on Postgres, this information should be added to the Other Data Types page by changing the section header (consistent with e.g. "Ranges (PostgreSQL Only").

If enums work on all dialects, the incorrect note "An enumeration, Postgres Only "should be deleted from the API reference

Additional context

edit: This concerns v6. v7 has an appropriate notice.

@ephys
Copy link
Member

ephys commented Sep 17, 2022

The API reference is wrong here, enums are compatible with at least mariadb, mysql, and postgres. Not sure about the others. This PR sequelize/sequelize#14505 removed the mention (for v7)

@ephys ephys removed the type: docs label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants