Skip to content

Commit ad44cc8

Browse files
committed
Clarify migrations when upgrading from version < 0.6.0
As pointed out in #348
1 parent 0749c60 commit ad44cc8

File tree

2 files changed

+4
-10
lines changed

2 files changed

+4
-10
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Solid Queue is configured by default in new Rails 8 applications. But if you're
1515

1616
This will configure Solid Queue as the production Active Job backend, create the configuration files `config/queue.yml` and `config/recurring.yml`, and create the `db/queue_schema.rb`. It'll also create a `bin/jobs` executable wrapper that you can use to start Solid Queue.
1717

18-
Once you've done that, you will then have to add the configuration for the queue database in `config/database.yml`. If you're using sqlite, it'll look like this:
18+
Once you've done that, you will then have to add the configuration for the queue database in `config/database.yml`. If you're using SQLite, it'll look like this:
1919

2020
```yaml
2121
production:
@@ -56,7 +56,7 @@ For small projects, you can run Solid Queue on the same machine as your webserve
5656

5757
### Single database configuration
5858

59-
It's also possible to use one single database for both production data:
59+
Running Solid Queue in a separate database is recommended, but it's also possible to use one single database for both the app and the queue. Just follow these steps:
6060

6161
1. Copy the contents of `db/queue_schema.rb` into a normal migration and delete `db/queue_schema.rb`
6262
2. Remove `config.solid_queue.connects_to` from `production.rb`

UPGRADING.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,17 @@ This version has two breaking changes regarding configuration:
44
- Recurring tasks are now defined in `config/recurring.yml` (by default). Before, they would be defined as part of the _dispatcher_ configuration. Now they've been upgraded to their own configuration file, and a dedicated process (the _scheduler_) to manage them. Check the _Recurring tasks_ section in the `README` to learn how to configure them in detail. They still follow the same format as before when they lived under `dispatchers > recurring_tasks`.
55

66
# Upgrading to version 0.8.x
7-
*IMPORTANT*: This version collapsed all migrations into a single `db/queue_schema.rb`, that will use a separate `queue` database. If you're upgrading from a version < 0.6.0, you need to upgrade to 0.6.0 first, ensure all migrations are up-to-date, and then upgrade further.
7+
*IMPORTANT*: This version collapsed all migrations into a single `db/queue_schema.rb`, that will use a separate `queue` database on install. If you're upgrading from a version < 0.6.0, you need to upgrade to 0.6.0 first, ensure all migrations are up-to-date, and then upgrade further. You don't have to switch to a separate `queue` database or use the new `db/queue_schema.rb` file, these are for people starting on a version >= 0.8.x. You can continue using your existing database (be it separate or the same as your app) as long as you run all migrations defined up to version 0.6.0.
88

99
# Upgrading to version 0.7.x
1010

1111
This version removed the new async mode introduced in version 0.4.0 and introduced a new binstub that can be used to start Solid Queue's supervisor.
1212

13-
To install both the binstub `bin/jobs` and the migration, you can just run
13+
To install the binstub `bin/jobs`, you can just run:
1414
```
1515
bin/rails generate solid_queue:install
1616
```
1717

18-
Or, if you're using a different database for Solid Queue:
19-
20-
```bash
21-
$ bin/rails generate solid_queue:install --database <the_name_of_your_solid_queue_db>
22-
```
23-
2418

2519
# Upgrading to version 0.6.x
2620

0 commit comments

Comments
 (0)