MySQL でフェデレーションクエリを実行する

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

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

• MySQL データベースへの接続。
• Unity Catalog で MySQL データベースをミラーリングする フォーリンカタログ で、クエリー 構文 Unity 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 MySQL.

5. (Optional) Add a comment.

6. Click Next.

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

   • Host: For example, mysql-demo.lb123.us-west-2.rds.amazonaws.com
   • Port: For example, 3306
   • User: For example, mysql_user
   • Password: For example, password123

8. (Optional): Select Trust server certificate. This is deselected by default. When selected, the transport layer uses SSL to encrypt the channel and bypasses the certificate chain to validate trust. Leave this set to the default unless you have a specific need to bypass trust validation.

9. Click Create connection.

10. 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.

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

12. Click Create catalog.

13. 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.

14. 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.

15. 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.

16. Click Next.

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

18. (Optional) Add a comment.

19. Click Save.

SQL

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

SQL

CREATE CONNECTION <connection-name> TYPE mysql
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 mysql
OPTIONS (
  host '<hostname>',
  port '<port>',
  user secret ('<secret-scope>','<secret-key-user>'),
  password secret ('<secret-scope>','<secret-key-password>')
)

If you must use plaintext strings in notebook SQL commands, avoid truncating the string by escaping special characters like $ with \. For example: \$.

For information about setting up secrets, see Secret management.

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

注記

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

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

フォーリンカタログを作成するには、Catalog ExplorerCREATE FOREIGN CATALOGSQL を使用するか、Databricks ノートブックまたは クエリ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 Databricks SQL 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.

SQL

CREATE FOREIGN CATALOG [IF NOT EXISTS] <catalog-name> USING CONNECTION <connection-name>;

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

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

• フィルター
• 予測
• 上限
• 関数: 部分的、フィルター式のみ。 (文字列関数、数学関数、日付、時刻、タイムスタンプ関数、およびエイリアス、キャスト、ソートオーダーなどのその他の関数)

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

• 集計
• Boolean オペレーター
• 次の数学関数 (ANSI が無効になっている場合はサポートされません): +、-、*、%、/
• ソート (制限付きで使用した場合)

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

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

データ型マッピング

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

MySQLタイプ	Spark タイプ
bigint (signedでない場合)、10 進数	DecimalType
tinyint*、int、integer、mediumint、smallint	IntegerType
bigint (signed)	LongType
float	FloatType
double	DoubleType
char, enum, set	CharType
varchar	VarcharType
json, longtext, mediumtext, text, tinytext	StringType
binary, blob, varbinary, varchar binary	BinaryType
bit, boolean	BooleanType
date, year	DateType
datetime, time, timestamp**	TimestampType/TimestampNTZType

*tinyint(1) signed と tinyint(1) unsigned はブール値として扱われ、 BooleanTypeに変換されます。 MySQL ドキュメントの Connector/J リファレンス を参照してください。

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