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

docs: adds Reserved Field Names section to migration guide #11308

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

PatrikKozak
Copy link
Contributor

@PatrikKozak PatrikKozak commented Feb 20, 2025

Added a new Reserved Field Names section to the migration guide.

Clarified that certain field names (__v, salt, hash, file, etc.) are reserved for internal use and will be sanitized from the config if used.

Included additional reserved names specific to MongoDB, authentication-enabled collections, and upload-enabled collections.

Added a note recommending against using field names with an underscore (_) prefix, as they are reserved for internal columns and may cause conflicts in SQL and other contexts.

Fixes #11159

Copy link
Contributor

@DanRibbens DanRibbens left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your list seems very incomplete and it would be helpful to know the conditions as to when the fields are used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add information about forbidden field names to the migration guide
3 participants