最終更新日 2020年06月17日(水)

Heroku Data Links を使用すると、Heroku Postgres データベースに異種のデータソース (Heroku Postgres など) を接続できます。 これにより、データが存在する場所に関係なく、SQL セマンティックスを使用してデータを読み取りおよび書き込みできます。

概要

Heroku Data Links は、外部データラッパーと呼ばれる Postgres のネイティブ機能を使用します。外部データラッパーを使用すると、開発者は、ローカルデータベース内のフェ デレーションテーブルにマッピングされるリモートデータベース内の外部サー バーとテーブルを指定できるようになります。

リモートデータベース内のデータに対するクエリを記述すると、Postgres は開発者に透過的にリモートデータに自動的にクエリを実行するため、ローカルデータでそのデータベースに参加できます。データが存在する場所や、それが Postgres でどのように抽象化されているかの詳細は、2 つのデータストアを接続する Postgres 拡張機能にプッシュダウンされます。

Heroku Data Links は、ローカルデータベース内でのサーバー仕様の作成や、リモートシステムでクエリを実行する対象のテーブルの作成など、外部データラッパーを管理するための困難な部分を処理します。

用語

Heroku Data Links に関するドキュメントでは、厳密な一連の用語を使用してすべての対話を定義します。

• リモート - Heroku Postgres データベースに接続されているデータストア。
• ローカル - 接続を受け付けている Heroku Postgres データベース。
• データリンク - リモートデータベースとローカルデータベースの間の接続の名前。

データリンクの一覧表示

作成されているデータリンクはすべて、Heroku CLI 経由で一覧表示できます。

$ heroku pg:links -a sushi
=== DATABASE_URL (warming-calmly-5763)
==== postgres_yellow
Created:     2015-06-23 20:58 UTC
Remote:      HEROKU_POSTGRESQL_BLUE_URL (swimming-newly-4067)
Remote Name: swimming_newly_4067

=== HEROKU_POSTGRESQL_CERULEAN_URL (drifting-coyly-8373)
==== reading_deeply_5049
Created:     2015-06-21 08:15 UTC
Remote:      HEROKU_POSTGRESQL_BLUE_URL (reading-deeply-5049)
Remote Name: reading_deeply_5049

=== HEROKU_POSTGRESQL_PINE_URL
No data sources are linked into this database.

=== HEROKU_POSTGRESQL_BURGUNDY
This operation is not supported by hobby-dev databases

このコマンドは、アプリケーションにアタッチされているすべてのデータベースを一覧表示します。 各データベース内では、関連付けられているデータベースに存在する各リンクが一覧表示されます。 上記の例では、DATABASE_URL​ がローカルデータベースであり、そのリソースアドオン名 warming-calmly-5763​ とも呼ばれます。

Remote:​ 行は、DATABASE_URL​ に接続されているデータベースの環境設定とリソース名を参照しています。Remote Name​ は、DATABASE_URL​ データベース内のサーバー参照です。

Heroku Postgres の Heroku Postgres へのリンク

Heroku Postgres を別の Heroku Postgres データベースにリンクすることもできます。

$ heroku pg:links:create HEROKU_POSTGRESQL_BLUE HEROKU_POSTGRESQL_RED --as datalink_test -a sushi

Heroku Postgres インスタンスがリンクされると、そのリンク名に基づいて Postgres に新しいスキーマが追加されます (この場合は、datalink_test​ スキーマ)。リモートデータストア HEROKU_POSTGRESQL_BLUE​ 内に people​ テーブルがある場合は、HEROKU_POSTGRESQL_RED​ データベースから、そのテーブルに次のようにクエリを実行できます。

SELECT * FROM datalink_test.people;

Heroku Redis の Heroku Postgres へのリンク

データリンクの名前付け

リンクを作成する場合は、それにわかりやすい名前を付けることをお勧めします。Data Links の create コマンドには、--as​ フラグを使用してリンク名を上書きする機能があります。

$ heroku pg:links:create HEROKU_POSTGRESQL_RED HEROKU_POSTGRESQL_CERULEAN --as cerulean_red_data -a sushi

データリンクに名前が付けられた場合、リモートの Postgres テーブルには --as​ フラグと同じ名前を使用してクエリを実行する必要があります。

SELECT key, value FROM cerulean_red_data.redis;

データリンクの削除

CLI 経由でデータリンクを削除するには、次のようにします。

$ heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN session_data -a sushi
 !    WARNING: Destructive Action
 !    This command will affect the database: DATABASE
 !    This will delete session_data along with the tables and views created within it.
 !    This may have adverse effects for software written against the session_data schema.
 !    To proceed, type "sushi" or re-run this command with --confirm sushi
> sushi
Deleting link session_data in DATABASE... done