search

sequelize / website

Our beloved website that contains all versions of our documentations and the API references.
https://sequelize.org
29 stars 155 forks source link

Conflicting / missing information on enums #238

Open BillyWM opened 2 years ago

BillyWM commented 2 years ago

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 commented 2 years ago

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