PostgreSQLで横串検索を実行する

この記事では、PostgreSQL によって管理されていない データに対する実行クエリに対してフェデレーション クエリを実行するようにレイクハウスフェデレーションを設定する方法について説明します。Databricksレイクハウスフェデレーションの詳細については、「 レイクハウスフェデレーションとは」を参照してください。

レイクハウスフェデレーションを使用して PostgreSQL データベースの実行クエリに接続するには、 Databricks Unity Catalog メタストアに次のものを作成する必要があります。

• PostgreSQL データベースに対するクエリの実行への接続。
• のデータベースに対する実行クエリをミラーリングする フォーリンカタログ PostgreSQL Unity CatalogUnity Catalogクエリ構文とデータガバナンスツールを使用して、データベースへのDatabricks ユーザーアクセスを管理できます。

始める前に

ワークスペースの要件：

• Unity Catalogのワークスペースが有効になっています。

コンピュートの要件：

• コンピュート・リソースからターゲット・データベース・システムへのネットワーク接続。 「レイクハウスフェデレーションのネットワーキングに関する推奨事項」を参照してください。
• Databricks コンピュートは、 Databricks Runtime 13.3 LTS 以上、 および標準 または 専用 アクセスモードを使用する必要があります。
• SQLウェアハウスはProまたはServerlessで、2023.40以上を使用している必要があります。

必要な権限：

• 接続を作成するには、メタストア管理者か、ワークスペースに接続されているUnity Catalogメタストアの CREATE CONNECTION 権限を持つユーザーである必要があります。
• フォーリンカタログを作成するには、メタストアに対する CREATE CATALOG 権限を持ち、接続の所有者であるか、接続に対する CREATE FOREIGN CATALOG 権限を持っている必要があります。

追加の権限要件は、以下の各タスクベースのセクションに記載しています。

接続を作成する

接続では、外部データベースシステムにアクセスするためのパスと認証情報を指定します。接続を作成するには、カタログエクスプローラーを使用するか、Databricksノートブックまたは Databricks SQLクエリーエディタで CREATE CONNECTION SQLコマンドを使用できます。

注記

Databricks REST API または Databricks CLI を使用して接続を作成することもできます。 POST /api/2.1/unity-catalog/connections を参照してください。 および Unity Catalog コマンド。

必要な権限： メタストア管理者またはCREATE CONNECTION権限を持つユーザー。

Catalog Explorer

1. In your Databricks workspace, click Catalog.

2. At the top of the Catalog pane, click the Add icon and select Add a connection from the menu.

   Alternatively, from the Quick access page, click the External data > button, go to the Connections tab, and click Create connection.

3. On the Connection basics page of the Set up connection wizard, enter a user-friendly Connection name.

4. Select a Connection type of PostgreSQL.

5. (Optional) Add a comment.

6. Click Next.

7. On the Authentication page, enter the following connection properties for your PostgreSQL instance.

   • Host: For example, postgres-demo.lb123.us-west-2.rds.amazonaws.com
   • Port: For example, 5432
   • User: For example, postgres_user
   • Password: For example, password123

8. Click Create connection.

9. On the Catalog basics page, enter a name for the foreign catalog. A foreign catalog mirrors a database in an external data system so that you can query and manage access to data in that database using Databricks and Unity Catalog.

10. (Optional) Click Test connection to confirm that it works.

11. Click Create catalog.

12. On the Access page, select the workspaces in which users can access the catalog you created. You can select All workspaces have access, or click Assign to workspaces, select the workspaces, and then click Assign.

13. Change the Owner who will be able to manage access to all objects in the catalog. Start typing a principal in the text box, and then click the principal in the returned results.

14. Grant Privileges on the catalog. Click Grant:

    1. Specify the Principals who will have access to objects in the catalog. Start typing a principal in the text box, and then click the principal in the returned results.
    2. Select the Privilege presets to grant to each principal. All account users are granted BROWSE by default.
       • Select Data Reader from the drop-down menu to grant read privileges on objects in the catalog.
       • Select Data Editor from the drop-down menu to grant read and modify privileges on objects in the catalog.
       • Manually select the privileges to grant.
    3. Click Grant.

15. Click Next.

16. On the Metadata page, specify tags key-value pairs. For more information, see Apply tags to Unity Catalog securable objects.

17. (Optional) Add a comment.

18. Click Save.

SQL

Run the following command in a notebook or the Databricks SQL query editor.

SQL

CREATE CONNECTION <connection-name> TYPE postgresql
OPTIONS (
  host '<hostname>',
  port '<port>',
  user '<user>',
  password '<password>'
);

We recommend that you use Databricks secrets instead of plaintext strings for sensitive values like credentials. For example:

SQL

CREATE CONNECTION <connection-name> TYPE postgresql
OPTIONS (
  host '<hostname>',
  port '<port>',
  user secret ('<secret-scope>','<secret-key-user>'),
  password secret ('<secret-scope>','<secret-key-password>')
)

For information about setting up secrets, see Secret management.

フォーリンカタログの作成

注記

UI を使用してデータソースへの接続を作成する場合は、フォーリンカタログの作成が含まれているため、この手順をスキップできます。

フォーリンカタログは、外部データシステム内のデータベースをミラーリングするため、DatabricksとUnity Catalogを使用して、そのデータベース内のデータへのアクセスを管理できます。フォーリンカタログを作成するには、すでに定義されているデータソースへの接続を使用します。

フォーリンカタログを作成するには、Catalog ExplorerCREATE FOREIGN CATALOGSQL を使用するか、Databricks ノートブックまたは クエリSQL エディターの コマンドを使用します。Databricks REST API または Databricks CLI を使用してカタログを作成することもできます。 POST /api/2.1/unity-catalog/catalogs を参照してください。 および Unity Catalog コマンド。

必要な権限： メタストアの CREATE CATALOG 権限、接続の所有権または接続の CREATE FOREIGN CATALOG 権限。

Catalog Explorer

1. In your Databricks workspace, click Catalog to open Catalog Explorer.

2. At the top of the Catalog pane, click the Add icon and select Add a catalog from the menu.

   Alternatively, from the Quick access page, click the Catalogs button, and then click the Create catalog button.

3. Follow the instructions for creating foreign catalogs in Create catalogs.

SQL

Run the following SQL command in a notebook or SQL query editor. Items in brackets are optional. Replace the placeholder values:

• <catalog-name>: Name for the catalog in Databricks.
• <connection-name>: The connection object that specifies the data source, path, and access credentials.
• <database-name>: Name of the database you want to mirror as a catalog in Databricks.

SQL

CREATE FOREIGN CATALOG [IF NOT EXISTS] <catalog-name> USING CONNECTION <connection-name>
OPTIONS (database '<database-name>');

サポートされているプッシュダウン

次のプッシュダウンは、すべてのコンピュートでサポートされています。

• フィルター
• 予測
• 上限
• 関数: 部分的、フィルター式のみ。 (文字列関数、数学関数、およびその他の関数 (Alias、Cast、SortOrder など)

次のプッシュダウンは、 Databricks Runtime 13.3 LTS 以上、および SQLウェアハウスでサポートされています。

• 次の集計関数: MIN、MAX、COUNT、SUM、AVG、VAR_POP、VAR_SAMP、STDDEV_POP、STDDEV_SAMP、GREATEST、LEAST、COVAR_POP、COVAR_SAMP、CORR、REGR_INTERCEPT、REGR_R2、REGR_SLOPE、REGR_SXY
• 次の Boolean 関数: =、<、<、=>、>=、<= >
• 次の数学関数 (ANSI が無効になっている場合はサポートされません): +、-、*、%、/
• その他の演算子 |そして~
• ソート (制限付きで使用した場合)

次のプッシュダウンはサポートされていません。

• テーブルのJOIN
• Windows の機能

データ型マッピング

PostgreSQL から Spark に読み取る場合、データ型は次のようにマップされます。

PostgreSQLタイプ	Spark タイプ
numeric	DecimalType
int2	ShortType
int4 (signedではない場合)	IntegerType
int8, oid, xid, int4 (signedの場合)	LongType
float4	FloatType
double precision, float8	DoubleType
char	CharType
name, varchar, tid	VarcharType
bpchar, character varying, json, money, point, super, text	StringType
bytea, geometry, varbyte	BinaryType
bit, bool	BooleanType
日付	DateType
tabstime, time, time with time zone, timetz, time without time zone, timestamp with time zone, timestamp, timestamptz, timestamp without time zone*	TimestampType/TimestampNTZType
Postgresql array type**	ArrayType

*Postgresql から読み取る場合、Postgresql Timestamp は Spark TimestampType にマッピングされます ( preferTimestampNTZ = false (デフォルト)。 PostgreSQL Timestamp は、preferTimestampNTZ = trueの場合、TimestampNTZType にマップされます。

**限られた配列タイプがサポートされています。