Skip to content

Commit eefb882

Browse files
committed
docs: add migration instructions for PostgreSQL and MySQL drivers in configuration
1 parent beedebe commit eefb882

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/configuration.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,14 @@ Configuration group: `postgres` (type: `PostgresConfig`)
246246

247247
**Context: Both dispatch and worker contexts** – Used for queue connections in both task dispatching and processing.
248248

249+
**⚠️ Migration Required:** Before using the PostgreSQL driver, you must run migrations to create the required database tables:
250+
251+
```bash
252+
uv run asynctasq migrate --driver postgres
253+
```
254+
255+
This creates the `task_queue` and `dead_letter_queue` tables with the necessary schema.
256+
249257
| Option | Type | Description | Default |
250258
| ------------------- | ---: | -------------------------------------- | ----------------------------------------------- |
251259
| `dsn` | str | PostgreSQL connection DSN | `postgresql://test:test@localhost:5432/test_db` |
@@ -279,6 +287,14 @@ Configuration group: `mysql` (type: `MySQLConfig`)
279287

280288
**Context: Both dispatch and worker contexts** – Used for queue connections in both task dispatching and processing.
281289

290+
**⚠️ Migration Required:** Before using the MySQL driver, you must run migrations to create the required database tables:
291+
292+
```bash
293+
uv run asynctasq migrate --driver mysql
294+
```
295+
296+
This creates the `task_queue` and `dead_letter_queue` tables with the necessary schema.
297+
282298
| Option | Type | Description | Default |
283299
| ------------------- | ---: | -------------------------------------- | ------------------------------------------ |
284300
| `dsn` | str | MySQL connection DSN | `mysql://test:test@localhost:3306/test_db` |

0 commit comments

Comments
 (0)