664
edits
Support/Developer Tips: Difference between revisions
Jump to navigation
Jump to search
adding migration section
m (→Download Cache: .zsh -> .zshrc) |
(adding migration section) |
||
| Line 1: | Line 1: | ||
Here are a few tips and tricks we've accumulated while working on the [[Support/Kitsune|new platform]]. Hopefully these are helpful to new developers or other contributors who want to get Kitsune up and running to hack on it. | Here are a few tips and tricks we've accumulated while working on the [[Support/Kitsune|new platform]]. Hopefully these are helpful to new developers or other contributors who want to get Kitsune up and running to hack on it. | ||
== Migrations == | |||
We use schema migrations to maintain our database structure. This allows us to keep a version history of the database (at least since the beginning of Kitsune). | |||
All our migrations are kept in the <code>/migrations/</code> folder, and start with a number. When adding a new migration, it needs to be the next in the sequence. So, for example, if the highest-numbered migration is 12, the next should be named <code>13-some-description.sql</code>. | |||
We have tools to help generate a migration—they're not perfect, but they get you started. | |||
=== <code>sqlall</code> === | |||
When you add a new app to the <code>INSTALLED_APPS</code> tuple, you can use the <code>sqlall</code> command to generate a migration. | |||
./manage.py sqlall <app-name> | |||
The resulting SQL will be pretty close to what you need. (You can drop the <code>BEGIN;</code> and <code>COMMIT;</code> statements, as schematic uses transactions automatically.) | |||
=== <code>sqldiff</code> === | |||
If you are making changes to a model in an app that already exists, you can use the <code>sqldiff</code> command to get the difference: | |||
./manage.py sqldiff <app-name> | |||
The resulting SQL will contain a lot more than you really need: it <code>ALTER</code>s every column. You should drop any statement that doesn't actually change anything, to make it easier for reviewers. | |||
== pip == | == pip == | ||