sqlalchemy / sqlalchemy/alembic

Documentation surrounding compare_type context param.

Open
#613 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
4.4k
Forks
375
PR merge metrics
No merged PRs in 30d

Description

In more than one place (here, and here), the docs state that noticing changes in string length will not happen, even if compare_type=True.

In responding to a SO question, I tested (very rudimentary) on PG and MySQL and notice that it does pick up a change in string length on both of those once compare_type is set.

Would you welcome some clarification to the docs here, or is this a feature that you aren't ready to commit to perhaps? I'm happy to chip in with docs changes.

Thanks for all your hard work and the great tools:)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked autogenerate documentation sections, especially “What does Autogenerate Detect” and “Comparing Types,” and compare their statements with the reported PostgreSQL and MySQL behavior when compare_type=True. Done means the documentation accurately clarifies whether string-length changes are detected and whether this behavior is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
mysql, postgresql, python, sqlalchemy
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.