1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
Metadata-Version: 2.1
Name: sqlite-migrate
Version: 0.1b0
Summary: A simple database migration system for SQLite, based on sqlite-utils
Author: Simon Willison
License: Apache-2.0
Project-URL: Homepage, https://github.com/simonw/sqlite-migrate
Project-URL: Changelog, https://github.com/simonw/sqlite-migrate/releases
Project-URL: Issues, https://github.com/simonw/sqlite-migrate/issues
Classifier: Development Status :: 2 - Pre-Alpha
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sqlite-utils
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: mypy; extra == "test"
Requires-Dist: black; extra == "test"
Requires-Dist: ruff; extra == "test"
# sqlite-migrate
[](https://pypi.org/project/sqlite-migrate/)
[](https://sqlite-migrate.datasette.io/en/stable/changelog.html)
[](https://github.com/simonw/sqlite-migrate/actions?query=workflow%3ATest)
[](https://github.com/simonw/sqlite-migrate/blob/main/LICENSE)
A simple database migration system for SQLite, based on [sqlite-utils](https://sqlite-utils.datasette.io/).
**This project is an early alpha. Expect breaking changes.**
## Installation
This tool works as a plugin for `sqlite-utils`. First [install that](https://sqlite-utils.datasette.io/en/stable/installation.html):
```bash
pip install sqlite-utils
```
Then install this plugin like so:
```bash
sqlite-utils install sqlite-migrate
```
## Migration files
This tool works against migration files. A migration file looks like this:
```python
from sqlite_migrate import Migrations
# Pick a unique name here - it must not clash with other migration sets that
# the user might run against the same database.
migration = Migrations("creatures")
# Use this decorator against functions that implement migrations
@migration()
def m001_create_table(db):
# db is a sqlite-utils Database instance
db["creatures"].create(
{"id": int, "name": str, "species": str},
pk="id"
)
@migration()
def m002_add_weight(db):
# db is a sqlite-utils Database instance
db["creatures"].add_column("weight", float)
```
Here is [documentation on the Database instance](https://sqlite-utils.datasette.io/en/stable/python-api.html) passed to each migration function.
## Running migrations
Running this command will execute those migrations in sequence against the specified database file.
Call `migrate` with a path to your database and a path to the migrations file you want to apply:
```bash
sqlite-utils migrate creatures.db path/to/migrations.py
```
Running this multiple times will have no additional affect, unless you add more migration functions to the file.
If you call it without arguments it will search for and apply any `migrations.py` files in the current directory or any of its subdirectories.
You can also pass the path to a directory, in which case all `migrations.py` files in that directory and its subdirectories will be applied:
```bash
sqlite-utils migrate creatures.db path/to/parent/
```
When applying a single migrations file you can use the `--stop-before` option to apply all migrations up to but excluding the specified migration:
```bash
sqlite-utils migrate creatures.db path/to/migrations.py --stop-before m002_add_weight
```
## Listing migrations
Add `--list` to list migrations without running them, for example:
```bash
sqlite-utils migrate creatures.db --list
```
The output will look something like this:
```
Migrations for: creatures
Applied:
m001_create_table - 2023-07-23 04:09:40.324002
m002_add_weight - 2023-07-23 04:09:40.324649
m003_add_age - 2023-07-23 04:09:44.441616
m003_cleanup - 2023-07-23 04:09:44.443394
m004_cleanup - 2023-07-23 04:09:44.444184
m005_cleanup - 2023-07-23 04:09:44.445389
m006_cleanup - 2023-07-23 04:09:44.446742
m007_cleanup - 2023-07-23 04:16:02.529983
Pending:
m008_cleanup
```
## Verbose mode
Add `-v` or `--verbose` for verbose output, which will show the schema before and after the migrations were applied along with a diff:
```bash
sqlite-utils migrate creatures.db --verbose
```
Example output:
```
Migrating creatures.db
Schema before:
CREATE TABLE "_sqlite_migrations" (
[migration_set] TEXT,
[name] TEXT,
[applied_at] TEXT,
PRIMARY KEY ([migration_set], [name])
);
CREATE TABLE [creatures] (
[id] INTEGER PRIMARY KEY,
[name] TEXT,
[species] TEXT
, [weight] FLOAT);
Schema after:
CREATE TABLE "_sqlite_migrations" (
[migration_set] TEXT,
[name] TEXT,
[applied_at] TEXT,
PRIMARY KEY ([migration_set], [name])
);
CREATE TABLE "creatures" (
[id] INTEGER PRIMARY KEY,
[name] TEXT,
[species] TEXT,
[weight] FLOAT,
[age] INTEGER,
[shoe_size] INTEGER
);
Schema diff:
[applied_at] TEXT,
PRIMARY KEY ([migration_set], [name])
);
-CREATE TABLE [creatures] (
+CREATE TABLE "creatures" (
[id] INTEGER PRIMARY KEY,
[name] TEXT,
- [species] TEXT
-, [weight] FLOAT);
+ [species] TEXT,
+ [weight] FLOAT,
+ [age] INTEGER,
+ [shoe_size] INTEGER
+);
```
|
