最終更新日 2023年03月28日(火)

この記事では、Heroku Postgres データベースのメジャー PostgreSQL バージョンをアップグレードする方法について説明します。Heroku でサポートされている最新のメジャー PostgreSQL バージョンは 15 です。

メジャー PostgreSQL バージョンのアップグレードは、Heroku CLI​ 経由でのみ実行できます。これは、慎重に実行する必要のある重大な操作です。

Heroku では、アップグレードのための 2 つの方法がサポートされています。どちらの方法でも、アップグレード中のデータ損失を防ぐために、ある程度のアプリケーションのダウンタイムが必要です。

データのチェックサム

Postgres 9.3 では、データ破損の早期検出のためにデータのチェックサム​が導入されました。最初に 9.3 より前のバージョンの PostgreSQL で Heroku Postgres データベースをプロビジョニングした場合は、チェックサムが有効になっていない​可能性があります。

heroku pg:psql​ セッションで次のクエリを実行して、データベースでチェックサムが有効になっている (on​) かどうかを確認します。

-- `on` means checksums are enabled, `off` means they are not enabled
=> SHOW data_checksums;
 data_checksums
----------------
 on
(1 row)

データベースで現在チェックサムが有効になっておらず、pg:copy のアップグレード​に必要となるダウンタイムがアプリで許容可能な場合は、アップグレードの一部としてチェックサムが確実に有効になるように pg:copy​ のアップグレード方法を使用します。

データベースの肥大化

データベースに多数の “肥大化”​ (使用されなくなった行によって占有される余分な領域) があり、pg:copy のアップグレード​に必要となるダウンタイムがアプリで許容可能な場合は、すべてのテーブルとインデックスを最初から再作成するために pg:copy​ のアップグレード方法を使用します。それを行うことにより、データベースからすべての肥大化が削除され、ディスク領域が節約されます。

ダウンタイムが主な考慮事項である場合は、代わりに pg:upgrade​ を使用します。

pg:upgrade でのアップグレード

pg:upgrade​ コマンドは、PostgreSQL の ​pg_upgrade​ ユーティリティを使用して PostgreSQL バージョンをその場でアップグレードします。このコマンドは、フォロワーデータベースのアップグレードにのみ使用できます。このデータベースは同じプランのままになりますが、現在のリーダーのフォローは停止します。

PostgreSQL バージョンおよび​プランの両方をアップグレードする必要がある場合は、別のプランで新しいフォロワーをプロビジョニングし、切り替えプロセス​の一部として pg:upgrade​ を実行します。

pg:upgrade​ を実行するには、約30 分間のアプリのダウンタイムが必要になります。この方法は、Essential 層プランを除くすべての Heroku Postgres プランでサポートされています。

1. フォロワーデータベースをプロビジョニングする

開始するには、データベースのフォロワーを作成し、そのフォロワーがリーダーデータベースに追いつくまで待ちます。次の例では、standard-2​ プランが使用されていますが、ニーズに最適なプラン​をプロビジョニングすることができます。

$ heroku addons:create heroku-postgresql:standard-2 --follow HEROKU_POSTGRESQL_LAVENDER_URL --app example-app
Adding heroku-postgresql:standard-2 to example-app... done, v71 ($200/mo)
Attached as HEROKU_POSTGRESQL_WHITE
Follower will become available for read-only queries when up-to-date
Use `heroku pg:wait` to track status

$ heroku pg:wait
Waiting for database HEROKU_POSTGRESQL_WHITE_URL... available

フォロワーは、プライマリデータベースまで 200 コミット以内のときに “追いついた” と見なされます。フォロワーが遅れているコミット数は、pg:info​ コマンドを使用して確認できます (フォロワーデータベースの Behind By​ 行を参照)。

$ heroku pg:info --app example-app
=== HEROKU_POSTGRESQL_LAVENDER
Plan:        Standard 0
Status:      available
...
=== HEROKU_POSTGRESQL_WHITE
Plan:        Standard 2
Status:      available
...
Following:   HEROKU_POSTGRESQL_LAVENDER (DATABASE_URL)
Behind By:   125 commits

2. データベースの書き込みを防止するためにメンテナンスモードにする

アップグレードプロセス中に、新しいデータは新しいデータベースに転送されないため、現在のプライマリデータベースに新しいデータが書き込まれないようにすることが重要です。これを行うには、アプリをメンテナンスモード​にします。スケジューラージョブも実行されている場合は、これを無効にします。メンテナンスモードの間、データベースでは請求時間が発生し続けます。

$ heroku maintenance:on --app example-app
Enabling maintenance mode for example-app... done

3. フォロワーデータベースをアップグレードする

メンテナンスモードになり、プライマリデータベースに追加データが書き込まれていない状態になったので、フォロワーデータベースをアップグレードできます。

フォロワーデータベースがプライマリに完全に​追いつくまで待ちます (0 commits​ 遅れていることで示される)。

$ heroku pg:info --app example-app
=== HEROKU_POSTGRESQL_LAVENDER_URL
Plan:        Standard 0
Status:      available
...
=== HEROKU_POSTGRESQL_WHITE_URL
Plan:        Standard 2
Status:      available
...
Following:   HEROKU_POSTGRESQL_LAVENDER_URL (DATABASE_URL)
Behind By:   0 commits

フォロワーが追いつくまで待たないと、次のエラーメッセージが表示されることがあります。

 ▸    database must not be too far behind leader, please wait until your follower catches up with its leader.

フォロワーが追いついたら、pg:upgrade​ コマンドを使用して、フォロワーの PostgreSQL バージョンをその場で更新します。アップグレードにより、フォロワーはプライマリデータベースのフォロー解除も行います。この手順は通常、完了するまでに約 20 分かかります。

$ heroku pg:upgrade HEROKU_POSTGRESQL_WHITE --app example-app

pg:wait​ を使用して、アップグレードの進捗状況を監視できます。

$ heroku pg:wait --app example-app

pg:upgrade​ プロセスの一部として、Heroku Postgres はデータベースに対して ANALYZE​ を実行します。これにより、データベースの統計が再計算され、バージョンアップグレードの後も Postgres クエリプランナーに確実に最新情報が保持されるようになります。

4. 新しいデータベースをプロモートする

新しくアップグレードされたデータベースをプロモートして、アプリケーションによって使用されるプライマリデータベース (DATABASE_URL​) として設定します。pg:promote​ では、新しい HEROKU_POSTGRESQL_<color>_URL​ 環境設定に割り当てられた、古いプライマリデータベースの代替アタッチメントも作成されます。このプロモーションプロセスによってリリースがトリガーされ、アプリが再起動されます。

$ heroku pg:promote HEROKU_POSTGRESQL_WHITE --app example-app
Promoting HEROKU_POSTGRESQL_WHITE_URL to DATABASE_URL... done

これで、フォロワーデータベースがプライマリデータベースになりました (ただし、アプリケーションはまだ新しいリクエストを受信していない)。

元のプライマリデータベースが複数のアプリにアタッチされていた場合は、heroku addons:attach​ を使用して新しいデータベースをこれらのアプリにアタッチする必要があります。

$ heroku addons:create heroku-postgresql:standard-0 --follow DATABASE_URL --app example-app

$ heroku pg:connection-pooling:attach DATABASE_URL --as MY_DATABASE_CONNECTION_POOL -a example-app

5. メンテナンスモードを終了する

通常のアプリケーション操作を再開するには、Web 以外のすべての dyno をその元のレベルにスケーリングします (heroku ps:scale worker=1​ など)。

最後に、メンテナンスモードをオフにします。

$ heroku maintenance:off --app example-app

アプリケーションが、更新されたデータベースインスタンスへのリクエストを受信するようになりました。これは、heroku pg:info​ を実行することによって確認できます。DATABASE_URL​ で示されるデータベースはプライマリデータベースと見なされます。

pg:copy でのアップグレード

pg:copy​ のアップグレード方法では、PostgreSQL のネイティブなバックアップと復元ユーティリティを使用します。データベースバックアップをディスクに書き込む代わりに、バックアップデータを新しくプロビジョニングされたデータベースの復元プロセスに直接ストリーミングします。

pg:copy​ の方法では、現在のデータベースの GB あたり約 3 分のアプリのダウンタイムが必要ですが、この量はスキーマやデータベースプランによって大きく異なる場合があります。必要なダウンタイムは、アップグレードをテストする​ (非本番アプリケーションの新しいデータベース上でアップグレードプロセスを実行する) ことによって見積もることができます。

pg:copy​ の方法では、サポートされているすべての Heroku Postgres プランおよびバージョン間でのアップグレードがサポートされます。これは、Essential 層データベースが関係するバージョン変更を行うための、または Essential 層データベースを別の層のプランにアップグレードするための唯一の方法です。pg:copy​ では、デフォルトの資格情報と、それでアクセスできるデータのみがコピーされます。その他の資格情報と、それでしかアクセスできないデータはコピーされません。

1. 新しいデータベースをプロビジョニングする

目的のプランの新しい Heroku Postgres データベースをプロビジョニングします (次の例では、standard-0​ プランが使用されていますが、ニーズに最適なプラン​をプロビジョニングする必要がある)。

$ heroku addons:create heroku-postgresql:standard-0 --app example-app
Adding heroku-postgresql:standard-0 on example-app... done, v122 ($50/mo)
The database should be available in 3-5 minutes

Standard、Premium、および Private 層データベースのプロビジョニングには数分かかります。pg:wait​ コマンドを使用すると、プロビジョニングがいつ完了したかの通知を受け取ることができます。

$ heroku pg:wait -a example-app
Waiting for database HEROKU_POSTGRESQL_PINK_URL... available

2. データベースの書き込みを防止するためにメンテナンスモードにする

アップグレードプロセス中に、新しいデータは新しいデータベースに転送されないため、現在のプライマリデータベースに新しいデータが書き込まれないようにすることが重要です。これを行うには、アプリをメンテナンスモード​にします。スケジューラージョブも実行されている場合は、これを無効にします。

$ heroku maintenance:on -a example-app
Enabling maintenance mode for example-app... done

3. データを新しいデータベースに転送する

データを現在のデータベースから新しくプロビジョニングされたデータベースにコピーするには、新しい​データベースの HEROKU_POSTGRESQL_COLOR​ 名を指定して pg:copy​ コマンドを使用します。

この例では、DATABASE_URL​ が転送するデータのソースであり、HEROKU_POSTGRESQL_PINK​ がターゲットデータベースです。

$ heroku pg:copy DATABASE_URL HEROKU_POSTGRESQL_PINK --app example-app

!    WARNING: Destructive Action
!    Transfering data from DATABASE_URL to HEROKU_POSTGRESQL_PINK
!    This command will affect the app: example-app
!    To proceed, type "example-app" or re-run this command with --confirm example-app

> example-app

4. 新しいデータベースをプロモートする

この時点で、新しいデータベースは元のデータベースからデータが入力されていますが、まだアプリケーションのアクティブなデータベースになっていません。新しいアップグレードされたデータベースをアプリケーションのプライマリデータベースにするには、次を使用してプロモートします。

$ heroku pg:promote HEROKU_POSTGRESQL_PINK --app example-app
Promoting HEROKU_POSTGRESQL_PINK_URL to DATABASE_URL... done

これで、アップグレードされたデータベースがプライマリデータベースになりました (ただし、アプリケーションはまだ新しいリクエストを受信していない)。

元のプライマリデータベースが複数のアプリにアタッチされていた場合は、heroku addons:attach​ を使用して新しいデータベースをこれらのアプリにアタッチする必要があります。

$ heroku addons:create heroku-postgresql:standard-0 --follow DATABASE_URL -a example-app

5. メンテナンスモードを終了する

通常のアプリケーション操作を再開するには、Web 以外のすべての dyno をその元のレベルにスケーリングします (heroku ps:scale worker=1​ など)。

最後に、メンテナンスモードをオフにします。

$ heroku maintenance:off --app example-app

アプリケーションが、新しいデータベースインスタンスへのリクエストを受信するようになりました。これは、heroku pg:info​ を実行することによって確認できます。DATABASE_URL​ で示されるデータベースはプライマリデータベースと見なされます。

古いプライマリデータベースのプロビジョニング解除

データベースをアップグレードした後、古いプライマリデータベースを必ずプロビジョニング解除してください。

$ heroku addons:destroy HEROKU_POSTGRESQL_LAVENDER --app example-app