Skip to content

Commit fae5c61

Browse files
committed
added troubleshooting section to auto migration docs, and fixed header formatting
1 parent 0f9b2e3 commit fae5c61

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/src/piccolo/migrations/create.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,8 @@ The contents of an empty migration file looks like this:
4141
Replace the `run` function with whatever you want the migration to do -
4242
typically running some SQL. It can be a function or a coroutine.
4343

44-
4544
The golden rule
46-
~~~~~~~~~~~~~~~
45+
---------------
4746

4847
Never import your tables directly into a migration, and run methods on them.
4948

@@ -95,3 +94,11 @@ Creating an auto migration:
9594
.. warning:: Auto migrations aren't supported in SQLite, because of SQLite's
9695
extremely limited support for SQL Alter statements. This might change in
9796
the future.
97+
98+
Troubleshooting
99+
~~~~~~~~~~~~~~~
100+
101+
Auto migrations can accomodate most schema changes. There may be some rare edge
102+
cases where a single migration is trying to do too much in one go, and fails.
103+
To avoid these situations, create auto migrations frequently, and keep them
104+
fairly small.

0 commit comments

Comments
 (0)