Django

Mon, 01 Jan 0001 00:00:00 +0000

Django#

See Getting started for usage examples.

colref locates models.py automatically by walking the target directory. All models.py files found are parsed and merged.

If the same model name appears in more than one models.py, colref exits with an error and lists the conflicting files:

model "User" found in multiple files:
 accounts/models.py
 legacy/models.py
Use --model to disambiguate.

The following directories are never scanned:

See Detection patterns — Django for the full per-pattern breakdown.

Mon, 01 Jan 0001 00:00:00 +0000

See Getting started for usage examples.

colref looks for a schema source in the following order:

db/schema.rb — the standard Rails schema dump (:ruby format). Present in most projects.
db/structure.sql — used when config.active_record.schema_format = :sql (PostgreSQL-specific features such as custom types, partial indexes, or materialized views that schema.rb cannot represent). Supports PostgreSQL, MySQL, and SQLite quoting styles.
db/migrate/ — fallback when no schema dump is committed. colref replays migration files in timestamp order — create_table, add_column, remove_column, rename_column, drop_table — to reconstruct the current schema.

Model and field validation are fully intact regardless of which source is used.