sqlx 0.9.0

🧰 The Rust SQL Toolkit. An async, pure Rust SQL crate featuring compile-time checked queries without a DSL. Supports PostgreSQL, MySQL, and SQLite.
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
name: Examples

on:
  pull_request:
  push:
    branches:
      - main
      - '*-dev'

jobs:
  sqlx-cli:
    name: Build SQLx CLI
    runs-on: ubuntu-latest
    timeout-minutes: 30

    steps:
      - uses: actions/checkout@v4

      - name: Setup Rust
        run: |
          rustup show active-toolchain || rustup toolchain install
          rustup override set stable

      - uses: Swatinem/rust-cache@v2

      - run: >
          cargo build
          -p sqlx-cli
          --release
          --no-default-features
          --features mysql,postgres,sqlite,sqlx-toml,mysql-rsa

      - uses: actions/upload-artifact@v4
        with:
          name: sqlx-cli
          path: |
            target/release/sqlx
            target/release/cargo-sqlx

  mysql:
    name: MySQL Examples
    runs-on: ubuntu-latest
    needs: sqlx-cli
    timeout-minutes: 30

    strategy:
      matrix:
        offline: ['', 'offline']

    services:
      mysql:
        image: mysql:latest
        env:
          MYSQL_ROOT_PASSWORD: password
        ports:
          - 3306:3306

    steps:
      - name: Get SQLx-CLI
        uses: actions/download-artifact@v4
        with:
          name: sqlx-cli
          # $HOME is interpreted differently by the shell
          path: /home/runner/.local/bin

      - run: |
          ls -R /home/runner/.local/bin
          chmod +x /home/runner/.local/bin/sqlx /home/runner/.local/bin/cargo-sqlx
          echo /home/runner/.local/bin >> $GITHUB_PATH
          sleep 10

      - uses: actions/checkout@v4

      - name: Setup Rust
        run: rustup show active-toolchain || rustup toolchain install

      - uses: Swatinem/rust-cache@v2

      - name: Todos (Setup)
        working-directory: examples/mysql/todos
        env:
          DATABASE_URL: mysql://root:password@localhost:3306/todos?ssl-mode=disabled
        run: sqlx db setup

      - name: Todos (Prepare)
        if: ${{ matrix.offline }}
        working-directory: examples/mysql/todos
        env:
          DATABASE_URL: mysql://root:password@localhost:3306/todos?ssl-mode=disabled
        run: cargo sqlx prepare

      - name: Todos (Check Offline)
        if: ${{ matrix.offline }}
        run: |
          cargo clean -p sqlx-example-mysql-todos
          cargo check -p sqlx-example-mysql-todos

      - name: Todos (Prepare from .env)
        if: ${{ matrix.offline }}
        working-directory: examples/mysql/todos
        run: |
          echo "DATABASE_URL=mysql://root:password@localhost:3306/todos?ssl-mode=disabled" > .env
          cargo clean -p sqlx-example-mysql-todos
          cargo sqlx prepare
          rm .env

      - name: Todos (Run)
        env:
          DATABASE_URL: mysql://root:password@localhost:3306/todos?ssl-mode=disabled
          SQLX_OFFLINE: ${{ matrix.offline == 'offline' }}
        run: cargo run -p sqlx-example-mysql-todos

  postgres:
    name: PostgreSQL Examples
    runs-on: ubuntu-latest
    needs: sqlx-cli
    timeout-minutes: 30

    strategy:
      matrix:
        offline: ['', 'offline']

    services:
      postgres:
        image: postgres:latest
        env:
          POSTGRES_PASSWORD: password
        ports:
          - 5432:5432

    steps:
      - name: Get SQLx-CLI
        uses: actions/download-artifact@v4
        with:
          name: sqlx-cli
          path: /home/runner/.local/bin

      - run: |
          ls -R /home/runner/.local/bin
          chmod +x $HOME/.local/bin/sqlx
          chmod +x $HOME/.local/bin/cargo-sqlx
          echo $HOME/.local/bin >> $GITHUB_PATH
          sleep 10

      - uses: actions/checkout@v4

      - name: Setup Rust
        run: rustup show active-toolchain || rustup toolchain install

      - name: Axum Social with Tests (Setup)
        working-directory: examples/postgres/axum-social-with-tests
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/axum-social
        run: sqlx db setup

      # Test `cargo sqlx prepare` setting `DATABASE_URL` both directly and in `.env`
      # This doesn't need to be done for every single example here, but should at least cover potential problem cases.
      - name: Axum Social with Tests (Prepare)
        if: ${{ matrix.offline }}
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/axum-social
        run: cargo sqlx prepare -- -p sqlx-example-postgres-axum-social

      - name: Axum Social with Tests (Check Offline)
        if: ${{ matrix.offline }}
        run: |
          cargo clean -p sqlx-example-postgres-axum-social
          cargo check -p sqlx-example-postgres-axum-social

      - name: Axum Social with Tests (Prepare from .env)
        if: ${{ matrix.offline }}
        run: |
          echo "DATABASE_URL=postgres://postgres:password@localhost:5432/axum-social" > .env
          cargo clean -p sqlx-example-postgres-axum-social
          cargo sqlx prepare -- -p sqlx-example-postgres-axum-social
          rm .env

      - name: Axum Social with Tests (Test)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/axum-social
          SQLX_OFFLINE: ${{ matrix.offline == 'offline' }}
        run: cargo test -p sqlx-example-postgres-axum-social

      # The Chat example has an interactive TUI which is not trivial to test automatically,
      # so we only check that it compiles.
      - name: Chat (Check)
        run: cargo check -p sqlx-example-postgres-chat

      - name: Files (Setup)
        working-directory: examples/postgres/files
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/files
        run: sqlx db setup

      - name: Files (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/files
        run: cargo run -p sqlx-example-postgres-files

      - name: JSON (Setup)
        working-directory: examples/postgres/json
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/json
        run: sqlx db setup

      - name: JSON (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/json
        run: cargo run -p sqlx-example-postgres-json

      - name: Listen (Setup)
        working-directory: examples/postgres/listen
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/listen
        run: sqlx db create

      - name: Listen (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/listen
        run: cargo run -p sqlx-example-postgres-listen

      - name: Mockable TODOs (Setup)
        working-directory: examples/postgres/mockable-todos
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/mockable-todos
        run: sqlx db setup

      - name: Mockable TODOs (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/mockable-todos
        run: cargo run -p sqlx-example-postgres-mockable-todos

      - name: Multi-Database (Setup)
        working-directory: examples/postgres/multi-database
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database
          ACCOUNTS_DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database-accounts
          PAYMENTS_DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database-payments
        run: |
          (cd accounts && sqlx db setup)
          (cd payments && sqlx db setup)
          sqlx db setup

      - name: Multi-Database (Prepare)
        if: ${{ matrix.offline }}
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database
          ACCOUNTS_DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database-accounts
          PAYMENTS_DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database-payments
        run: |
            cargo clean -p sqlx-example-postgres-multi-database-accounts
            cargo clean -p sqlx-example-postgres-multi-database-payments
            cargo clean -p sqlx-example-postgres-multi-database
            # should include -accounts and -payments
            cargo sqlx prepare -- -p sqlx-example-postgres-multi-database

      - name: Multi-Database (Check Offline)
        if: ${{ matrix.offline }}
        run: |
          cargo clean -p sqlx-example-postgres-multi-database
          cargo check -p sqlx-example-postgres-multi-database

      - name: Multi-Database (Prepare from .env)
        if: ${{ matrix.offline }}
        run: |
          # Tried to get this to work with heredocs but had trouble writing tabs in YAML
          echo 'DATABASE_URL=postgres://postgres:password@localhost:5432/multi-database' >.env
          # Important: append, don't truncate
          echo 'ACCOUNTS_DATABASE_URL=postgres://postgres:password@localhost:5432/multi-database-accounts' >> .env
          echo 'PAYMENTS_DATABASE_URL=postgres://postgres:password@localhost:5432/multi-database-payments' >> .env
          
          cargo clean -p sqlx-example-postgres-multi-database-accounts
          cargo clean -p sqlx-example-postgres-multi-database-payments
          cargo clean -p sqlx-example-postgres-multi-database
          cargo sqlx prepare -- -p sqlx-example-postgres-multi-database
          
          rm .env

      - name: Multi-Database (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database
          ACCOUNTS_DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database-accounts
          PAYMENTS_DATABASE_URL: postgres://postgres:password@localhost:5432/multi-database-payments
          SQLX_OFFLINE: ${{ matrix.offline == 'offline' }}
        run: cargo run -p sqlx-example-postgres-multi-database

      - name: Multi-Tenant (Setup)
        working-directory: examples/postgres/multi-tenant
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/multi-tenant
        run: |
          (cd accounts && sqlx db setup)
          (cd payments && sqlx migrate run)
          sqlx migrate run

      - name: Multi-Tenant (Prepare)
        if: ${{ matrix.offline }}
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/multi-tenant
        run: |
          cargo clean -p sqlx-example-postgres-multi-tenant-accounts
          cargo clean -p sqlx-example-postgres-multi-tenant-payments
          cargo clean -p sqlx-example-postgres-multi-tenant
          # should include -accounts and -payments
          cargo sqlx prepare -- -p sqlx-example-postgres-multi-tenant

      - name: Multi-Tenant (Check Offline)
        if: ${{ matrix.offline }}
        run: cargo check -p sqlx-example-postgres-multi-tenant

      - name: Multi-Tenant (Prepare from .env)
        if: ${{ matrix.offline }}
        run: |
          echo "DATABASE_URL=postgres://postgres:password@localhost:5432/multi-tenant" > .env
          
          cargo clean -p sqlx-example-postgres-multi-tenant-accounts
          cargo clean -p sqlx-example-postgres-multi-tenant-payments
          cargo clean -p sqlx-example-postgres-multi-tenant
          # should include -accounts and -payments
          cargo sqlx prepare -- -p sqlx-example-postgres-multi-tenant
          
          rm .env

      - name: Multi-Tenant (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/multi-tenant
          SQLX_OFFLINE: ${{ matrix.offline == 'offline' }}
        run: cargo run -p sqlx-example-postgres-multi-tenant

      - name: Preferred-Crates (Setup)
        working-directory: examples/postgres/preferred-crates
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/preferred-crates
        run: sqlx db setup

      - name: Preferred-Crates (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/preferred-crates
        run: cargo run -p sqlx-example-postgres-preferred-crates

      - name: TODOs (Setup)
        working-directory: examples/postgres/todos
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/todos
        run: sqlx db setup

      - name: TODOs (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/todos
        # TODO: test full CLI
        run: cargo run -p sqlx-example-postgres-todos

      - name: Transaction (Setup)
        working-directory: examples/postgres/transaction
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/txn
        run: sqlx db setup

      - name: Transaction (Run)
        env:
          DATABASE_URL: postgres://postgres:password@localhost:5432/txn
        run: cargo run -p sqlx-example-postgres-transaction

  sqlite:
    name: SQLite Examples
    runs-on: ubuntu-latest
    needs: sqlx-cli
    timeout-minutes: 30

    steps:
      - name: Get SQLx-CLI
        uses: actions/download-artifact@v4
        with:
          name: sqlx-cli
          path: /home/runner/.local/bin

      - run: |
          ls -R /home/runner/.local/bin
          chmod +x /home/runner/.local/bin/sqlx
          echo /home/runner/.local/bin >> $GITHUB_PATH

      - uses: actions/checkout@v4

      - name: Setup Rust
        run: rustup show active-toolchain || rustup toolchain install

      - uses: Swatinem/rust-cache@v2

      - name: TODOs (Setup)
        env:
          DATABASE_URL: sqlite://todos.sqlite
        run: sqlx db setup --source=examples/sqlite/todos/migrations

      - name: Todos (Prepare)
        if: ${{ matrix.offline }}
        env:
          DATABASE_URL: sqlite://todos.sqlite
        run: cargo sqlx prepare -- -p sqlx-example-sqlite-todos

      - name: Todos (Check Offline)
        if: ${{ matrix.offline }}
        run: |
          cargo clean -p sqlx-example-sqlite-todos
          cargo check -p sqlx-example-sqlite-todos

      - name: Todos (Prepare from .env)
        if: ${{ matrix.offline }}
        run: |
          echo "DATABASE_URL=sqlite://todos.sqlite" > .env
          cargo clean -p sqlx-example-sqlite-todos
          cargo sqlx prepare -- -p sqlx-example-sqlite-todos
          rm .env

      - name: TODOs (Run)
        env:
          DATABASE_URL: sqlite://todos.sqlite
          SQLX_OFFLINE: ${{ matrix.offline == 'offline' }}
        run: cargo run -p sqlx-example-sqlite-todos