sqlx-cli 0.9.0

Command-line utility for SQLx, the Rust SQL toolkit.
Documentation 
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259

mod common;

use common::MigrateCommand;
use common::TestDatabase;

#[tokio::test]
async fn run_reversible_migrations() {
    let all_migrations: Vec<i64> = vec![
        20230101000000,
        20230201000000,
        20230301000000,
        20230401000000,
        20230501000000,
    ];
    // Without --target-version specified.k
    {
        let db = TestDatabase::new("run_reversible_latest", "migrations_reversible");
        db.run_migration(MigrateCommand::Run, None, false).success();
        assert_eq!(db.applied_migrations().await, all_migrations);
    }
    // With --target-version specified.
    {
        let db = TestDatabase::new("run_reversible_latest_explicit", "migrations_reversible");

        // Move to latest, explicitly specified.
        db.run_migration(MigrateCommand::Run, Some(20230501000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);

        // Move to latest when we're already at the latest.
        db.run_migration(MigrateCommand::Run, Some(20230501000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);

        // Upgrade to an old version.
        db.run_migration(MigrateCommand::Run, Some(20230301000000), false)
            .failure();
        assert_eq!(db.applied_migrations().await, all_migrations);
    }
    // With --target-version, incrementally upgrade.
    {
        let db = TestDatabase::new("run_reversible_incremental", "migrations_reversible");

        // First version
        db.run_migration(MigrateCommand::Run, Some(20230101000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Dry run upgrade to latest.
        db.run_migration(MigrateCommand::Run, None, true).success();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Dry run upgrade + 2
        db.run_migration(MigrateCommand::Run, Some(20230301000000), true)
            .success();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Upgrade to non-existent version.
        db.run_migration(MigrateCommand::Run, Some(20230901000000999), false)
            .failure();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Upgrade + 1
        db.run_migration(MigrateCommand::Run, Some(20230201000000), false)
            .success();
        assert_eq!(
            db.applied_migrations().await,
            vec![20230101000000, 20230201000000]
        );

        // Upgrade + 2
        db.run_migration(MigrateCommand::Run, Some(20230401000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..4]);
    }
}

#[tokio::test]
async fn revert_migrations() {
    let all_migrations: Vec<i64> = vec![
        20230101000000,
        20230201000000,
        20230301000000,
        20230401000000,
        20230501000000,
    ];

    // Without --target-version
    {
        let db = TestDatabase::new("revert_incremental", "migrations_reversible");
        db.run_migration(MigrateCommand::Run, None, false).success();

        // Dry-run
        db.run_migration(MigrateCommand::Revert, None, true)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);

        // Downgrade one
        db.run_migration(MigrateCommand::Revert, None, false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..4]);

        // Downgrade one
        db.run_migration(MigrateCommand::Revert, None, false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..3]);
    }
    // With --target-version
    {
        let db = TestDatabase::new("revert_incremental", "migrations_reversible");
        db.run_migration(MigrateCommand::Run, None, false).success();

        // Dry-run downgrade to version 3.
        db.run_migration(MigrateCommand::Revert, Some(20230301000000), true)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);

        // Downgrade to version 3.
        db.run_migration(MigrateCommand::Revert, Some(20230301000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..3]);

        // Try downgrading to the same version.
        db.run_migration(MigrateCommand::Revert, Some(20230301000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..3]);

        // Try downgrading to a newer version.
        db.run_migration(MigrateCommand::Revert, Some(20230401000000), false)
            .failure();
        assert_eq!(db.applied_migrations().await, all_migrations[..3]);

        // Try downgrading to a non-existent version.
        db.run_migration(MigrateCommand::Revert, Some(9999), false)
            .failure();
        assert_eq!(db.applied_migrations().await, all_migrations[..3]);

        // Ensure we can still upgrade
        db.run_migration(MigrateCommand::Run, Some(20230401000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..4]);

        // Downgrade to zero.
        db.run_migration(MigrateCommand::Revert, Some(0), false)
            .success();
        assert_eq!(db.applied_migrations().await, Vec::<i64>::new());
    }
}

#[tokio::test]
async fn skip_reversible_migrations() {
    let all_migrations: Vec<i64> = vec![
        20230101000000,
        20230201000000,
        20230301000000,
        20230401000000,
        20230501000000,
    ];
    // Without --target-version specified.
    {
        let db = TestDatabase::new("migrate_skip_reversible_latest", "migrations_reversible");
        db.run_migration(MigrateCommand::Skip, None, false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);
    }
    // With --target-version specified.
    {
        let db = TestDatabase::new(
            "migrate_skip_reversible_latest_explicit",
            "migrations_reversible",
        );

        // Move to latest, explicitly specified.
        db.run_migration(MigrateCommand::Run, Some(20230501000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);

        // Skip to latest when we're already at the latest.
        db.run_migration(MigrateCommand::Skip, Some(20230501000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations);

        // Upgrade to an old version.
        db.run_migration(MigrateCommand::Skip, Some(20230301000000), false)
            .failure();
        assert_eq!(db.applied_migrations().await, all_migrations);
    }
    // With --target-version, incrementally upgrade.
    {
        let db = TestDatabase::new(
            "migrate_skip_reversible_incremental",
            "migrations_reversible",
        );

        // Run first version
        db.run_migration(MigrateCommand::Run, Some(20230101000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Skip and dry run upgrade to latest.
        db.run_migration(MigrateCommand::Skip, None, true).success();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Skip and dry run upgrade + 2
        db.run_migration(MigrateCommand::Skip, Some(20230301000000), true)
            .success();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Skip to to non-existent version.
        db.run_migration(MigrateCommand::Skip, Some(20230901000000999), false)
            .failure();
        assert_eq!(db.applied_migrations().await, vec![20230101000000]);

        // Upgrade + 1
        db.run_migration(MigrateCommand::Run, Some(20230201000000), false)
            .success();
        assert_eq!(
            db.applied_migrations().await,
            vec![20230101000000, 20230201000000]
        );

        // Skip + 2
        db.run_migration(MigrateCommand::Skip, Some(20230401000000), false)
            .success();
        assert_eq!(db.applied_migrations().await, all_migrations[..4]);
    }
}

#[tokio::test]
async fn ignored_chars() {
    let mut db = TestDatabase::new("ignored-chars", "ignored-chars/LF");
    db.config_path = Some("tests/ignored-chars/sqlx.toml".into());

    db.run_migration(MigrateCommand::Run, None, false).success();

    db.set_migrations("ignored-chars/CRLF");

    let expected_info = "1/installed user\n2/installed post\n3/installed comment\n";

    // `ignored-chars` should produce the same migration checksum here
    db.migrate_info().success().stdout(expected_info);

    // Running migration should be a no-op
    db.run_migration(MigrateCommand::Run, None, false)
        .success()
        .stdout("");

    db.set_migrations("ignored-chars/BOM");
    db.migrate_info().success().stdout(expected_info);
    db.run_migration(MigrateCommand::Run, None, false)
        .success()
        .stdout("");

    db.set_migrations("ignored-chars/oops-all-tabs");
    db.migrate_info().success().stdout(expected_info);
    db.run_migration(MigrateCommand::Run, None, false)
        .success()
        .stdout("");
}