Heroku Data Labs スターターガイド

最終更新日 2023年05月11日(木)

Heroku Data アドオンには、Heroku プラットフォームへの組み込みが検討されている試験的な機能があります。data:labs​ コマンドを使用することで、Heroku Data アドオンの試験的な機能を有効化および無効化できます。Heroku Data Labs 機能は、本番環境 Heroku Postgres プラン (Standard、Premium、Private、Shield) でのみ利用できます。

Heroku Data Labs を通じて追加された機能は実験的であり、変更される場合があります。

Heroku Data CLI プラグインをインストールまたは更新する

data:labs command​ を使用するには、最新バージョンの Heroku Data CLI プラグインが必要です。

Heroku Data CLI プラグインのインストール

data プラグインをインストールするには、次の CLI コマンドを使用します。

$ heroku plugins:install @heroku-cli/plugin-data

Heroku Data CLI プラグインの更新

Heroku CLI は自動的に更新されます。ただし、Debian/Ubuntu パッケージをインストールしたか、npm install​ を使用した場合は、CLI を手動で更新する必要があります。data​ プラグインを更新するには、update CLI コマンドを使用します。

$ heroku update

使用できる試験的な機能を一覧表示する

Heroku アドオンで使用できる試験的な機能の一覧を表示するには、heroku data:labs:list​ コマンドを使用します。

$ heroku data:labs:list ADDON_NAME
=== Experimental Features Available for ADDON_NAME:

list コマンドでは、Heroku アドオンで使用可能な機能のステータスも表示されます。たとえば、Heroku Postgres アドオンで WAL 圧縮が使用可能な場合は、次のようになります。

$ heroku data:labs:list postgresql-example-1234
=== Experimental Features Available for postgresql-example-1234:
[+] wal-compression         Write-ahead log compression on Heroku Postgres addons

試験的な機能を有効にする

Heroku アドオンの試験的な機能を有効にするには、heroku data:labs:enable​ コマンドを使用します。--addon​ フラグを含める必要があります。詳細な指定のために -a​、--app​ フラグを指定することもできます。

$ heroku data:labs:enable FEATURE --addon=ADDON_NAME -a example-app
Enabling FEATURE on ADDON_NAME... done

機能によっては、有効化には 15 分以上かかることもあります。heroku data:labs:list コマンドを使用してステータスを確認できます。

試験的な機能を無効にする

Heroku アドオンの試験的な機能を無効にする操作は、有効化に似ています。heroku data:labs:disable コマンドを使用します。--addon​ フラグが必須です。

$ heroku data:labs:disable FEATURE --addon=ADDON_NAME -a example-app
Disabling FEATURE on ADDON_NAME... done