Skip to content

docs: clarify transform() behavior for indexes, views and triggers - #851

Open
princethummar1 wants to merge 1 commit into
simonw:mainfrom
princethummar1:docs/clarify-transform-indexes-views-849
Open

docs: clarify transform() behavior for indexes, views and triggers#851
princethummar1 wants to merge 1 commit into
simonw:mainfrom
princethummar1:docs/clarify-transform-indexes-views-849

Conversation

@princethummar1

@princethummar1 princethummar1 commented Aug 31, 2026

Copy link
Copy Markdown

Closes #849

Summary of Change

Updates the overview paragraph in the Custom transformations with .transform_sql() section of the Python API documentation to accurately reflect the current behavior of .transform():

  • Indexes: Preserves and recreates indexes where possible (rather than stating they are not upgraded).
  • Views: Cross-references the Tables referenced by views section explaining that referenced tables are safely transformed without breaking view definitions.
  • Triggers & Column Changes: Clarifies that view definitions and triggers referencing renamed or dropped columns must still be manually updated.

Verification

  • Ran cog -r docs/*.rst
  • Ran flake8 and mypy sqlite_utils (clean pass)
  • Ran pytest tests/test_docs.py tests/test_transform.py (212 passed)

📚 Documentation preview 📚: https://sqlite-utils--851.org.readthedocs.build/en/851/

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

Successfully merging this pull request may close these issues.

Clarify transform() behavior for indexes, views and triggers

1 participant