Skip to content

Fix docs incorrectly stating primary keys default to unsigned #1015

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

Jump to bottom
Open
dereuromark wants to merge 2 commits into
base: 5.x
Choose a base branch
from
Open

Fix docs incorrectly stating primary keys default to unsigned #1015

dereuromark wants to merge 2 commits into from
+9 −4

Conversation

@dereuromark
Copy link
Member

@dereuromark dereuromark commented Jan 29, 2026

Summary

  • The docs in writing-migrations.rst claimed primary keys are unsigned by default, but the code defaults to signed (see MysqlAdapter line 275 and Column::getUnsigned())
  • Updated the table option description: signed defaults to true (not false)
  • Updated the prose to say "By default, the primary key is signed" and point to the Migrations.unsigned_primary_keys feature flag
  • Added a .. _feature-flags: ref label to index.rst so the cross-reference works

@dereuromark dereuromark requested a review from markstory January 29, 2026 04:19
@dereuromark
Fix docs incorrectly stating primary keys default to unsigned
d6e4487 
The documentation claimed primary keys are unsigned by default, but the
actual code defaults to signed. Unsigned primary keys require either
passing 'signed' => false or enabling the Migrations.unsigned_primary_keys
feature flag.
@dereuromark dereuromark force-pushed the fix/docs-unsigned-primary-key-default branch from ba51013 to d6e4487 Compare January 29, 2026 04:21
@dereuromark
Mention unsigned_ints flag alongside unsigned_primary_keys
819d30e 
Both flags should be used together so foreign key columns match
the unsigned primary keys they reference.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@markstory markstory Awaiting requested review from markstory

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dereuromark