Skip to content

Commit 54664b2

Browse files
committed
Add upgrade notes to README
1 parent 9efebb2 commit 54664b2

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
django-db-queue
22
==========
3-
[![Build Status](https://travis-ci.org/dabapps/django-db-queue.svg)](https://travis-ci.org/dabapps/django-db-queue)
43
[![pypi release](https://img.shields.io/pypi/v/django-db-queue.svg)](https://pypi.python.org/pypi/django-db-queue)
54

6-
Simple databased-backed job queue. Jobs are defined in your settings, and are processed by management commands.
5+
Simple database-backed job queue. Jobs are defined in your settings, and are processed by management commands.
76

87
Asynchronous tasks are run via a *job queue*. This system is designed to support multi-step job workflows.
98

109
Supported and tested against:
11-
- Django 1.11 and 2.2
12-
- Python 3.5, 3.6, 3.7 and 3.8
13-
14-
This package may still work with older versions of Django and Python but they aren't explicitly supported.
10+
- Django 3.1 and 3.2
11+
- Python 3.6, 3.7, 3.8 and 3.9
1512

1613
## Getting Started
1714

@@ -28,6 +25,17 @@ Add `django_dbq` to your installed apps
2825
'django_dbq',
2926
)
3027

28+
### Upgrading from 1.x to 2.x
29+
30+
This library underwent significant changes in its 2.x release, which meant migrating automatically was not practical. Before upgrading, you should open a database shell and run the following commands. Note that this will **delete all your existing jobs**, so you should ensure all jobs are completed before proceeding, and make sure you don't need any data at all from the jobs table.
31+
32+
```
33+
DROP TABLE django_dbq_job;
34+
DELETE FROM django_migrations WHERE app='django_dbq';
35+
```
36+
37+
Then, run `python manage.py migrate` to recreate the jobs table.
38+
3139
### Describe your job
3240

3341
In e.g. project.common.jobs:

0 commit comments

Comments
 (0)