Paimon カタログは、Flink を OSS または DLF に保存されているデータレイクのメタデータに接続します。このドキュメントでは、カタログ、データベース、テーブルを作成および管理する方法について説明します。
事前準備
-
バージョン要件
-
VVR 8.0.5 以降: Paimon カタログとテーブルの作成に必要です。
-
VVR 11.1 以降: DLF をメタストアとして使用する場合に必要です。
-
VVR 11.8 以降: Paimon Filesystem カタログのストレージとして OSS-HDFS を使用する場合に必要です。
-
-
ストレージ要件
Paimon はデータとメタデータを OSS に保存します。ご利用の OSS バケットを次のように設定します。
-
ストレージクラス: 標準を使用します。ストレージクラス。
-
バケットのセットアップ: Flink ワークスペースと同じリージョンに専用のバケットを作成します。データの競合を避けるため、デフォルトのシステムバケットを再利用しないでください。
-
-
アクセス権限
AccessKey ペアが、ご利用の OSS バケットまたは DLF ディレクトリに対する読み取りおよび書き込み権限を持っていることを確認してください。 -
フォーマットの互換性
Paimon カタログは Paimon フォーマットのみをサポートします。Lance や Iceberg などの他のフォーマットはサポートされていません。
-
コンソールの更新
カタログ、データベース、またはテーブルを作成または削除した後、更新
をクリックしてコンソールを更新します。
-
Paimon バージョンマッピング
Apache Paimon バージョン
VVR
1.3.1
11.5、11.6、11.7、11.8
1.3
11.4
1.2
11.2、11.3
1.1
11.1
1.0
8.0.11
カタログの作成
シナリオに基づいてメタストアのタイプを選択します。
-
Filesystem カタログ: メタデータを OSS に保存します。シンプルなデプロイメントに最適です。
-
DLF カタログ: メタデータを Data Lake Formation (DLF) に保存します。メタデータを一元管理するエンタープライズシナリオに最適です。
Filesystem カタログの作成
オプション 1: コンソールを使用 (推奨)
-
[カタログ] ページに移動します。
-
管理ポータルにログインします。対象のワークスペースを見つけ、[操作] 列の [コンソール] をクリックします。
-
左側のナビゲーションウィンドウで、[カタログ] をクリックします。
-
-
[カタログの作成] をクリックし、[Apache Paimon] を選択してから [次へ] をクリックします。
-
metastoreをfilesystemに設定し、他のカタログ設定を構成します。
オプション 2: SQL を使用
[開発] > [スクリプト] の SQL エディターで、次のコマンドを実行します:
CREATE CATALOG `my-catalog` WITH (
'type' = 'paimon',
'metastore' = 'filesystem',
'warehouse' = '<warehouse>',
'fs.oss.endpoint' = '<fs.oss.endpoint>',
'fs.oss.accessKeyId' = '<fs.oss.accessKeyId>',
'fs.oss.accessKeySecret' = '<fs.oss.accessKeySecret>'
);
-
一般パラメーター
設定項目
説明
必須
備考
my-catalogPaimon カタログの名前。
はい
カスタム名を入力します。
typeカタログのタイプ。
はい
paimonに設定します。metastoreメタストアのタイプ。
はい
有効な値:
-
filesystem: メタデータを OSS に保存します。 -
dlf: メタデータを DLF に保存します。
-
-
OSS パラメーター
設定項目
説明
必須
備考
warehouse
OSS 内のデータウェアハウスディレクトリ。
はい
フォーマットは
oss://<bucket>/<object>です。各パラメーターの説明は次のとおりです。-
bucket: ご利用の OSS バケットの名前。 -
object: データが保存されているパス。
OSS コンソールでバケットとオブジェクト名を確認します。
fs.oss.endpoint
OSS サービスのエンドポイント。
はい
-
Flink と DLF が同じリージョンにある場合は、VPC エンドポイントを使用します。それ以外の場合は、パブリックネットワークエンドポイントを使用します。
-
このパラメーターは、warehouse に指定された OSS バケットが Flink ワークスペースと同じリージョンにない場合、または別の Alibaba Cloud アカウントに属する OSS バケットを使用する場合に必要です。
詳細については、「リージョンとエンドポイント」および「AccessKey の作成」をご参照ください。
fs.oss.accessKeyId
OSS に対する読み取りおよび書き込み権限を持つ Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey ID。
はい
fs.oss.accessKeySecret
OSS に対する読み取りおよび書き込み権限を持つ Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey Secret。
はい
-
-
OSS-HDFS (VVR 11.8 以降)
Paimon Filesystem カタログのストレージとして OSS-HDFS を使用するには、次の SQL 例を使用します。
CREATE CATALOG `my_catalog` WITH ( 'type' = 'paimon', 'metastore' = 'filesystem', 'warehouse' = 'dls://<bucket>.<dls-endpoint>/<warehouse-path>', 'fs.oss.endpoint' = '<dls-endpoint>', 'fs.oss.accessKeyId' = '<access-key-id>', 'fs.oss.accessKeySecret' = '<access-key-secret>', 'fs.dls.client.mode.enabled' = 'false', 'fs.dls.data.endpoint' = '<oss-data-endpoint>' );次の表にパラメーターを説明します。
パラメーター
説明
必須
備考
warehouse
OSS-HDFS のウェアハウスディレクトリ。
はい
フォーマット: dls://<bucket>.<dls-endpoint>/<warehouse-path>。<dls-endpoint> は
fs.oss.endpointと同じです。fs.oss.endpoint
OSS-HDFS サービスのエンドポイント。
はい
OSS コンソールで、対象バケットの [概要] > [アクセスポート] セクションに移動し、HDFS サービスエンドポイントを確認します。
fs.oss.accessKeyId
OSS-HDFS に対する読み取りおよび書き込み権限を持つ Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey ID。
はい
—
fs.oss.accessKeySecret
AccessKey ID に対応する AccessKey Secret。
はい
—
fs.dls.client.mode.enabled
DLS クライアントモードを有効にするかどうかを指定します。
はい
falseに設定します。fs.dls.data.endpoint
DLS が基盤となる OSS データにアクセスするために使用するデータエンドポイント。
はい
OSS コンソールで、対象バケットの [概要] > [アクセスポート] セクションに移動し、OSS 内部エンドポイントを確認します。「リージョンとエンドポイント」のドキュメントも参照できます。
DLF カタログの作成
DLF
-
Flink ワークスペースと同じリージョンの DLF コンソールでカタログを作成します。DLF のクイックスタート。
-
開発コンソールで Paimon カタログを登録します。
説明この操作は、DLF カタログをメタデータとしてマッピングするだけです。Realtime Compute for Apache Flink でこのカタログを作成または削除しても、DLF の基盤となるデータには影響しません。
-
Realtime Compute コンソールにログインします。
フルマネージドワークスペースのリストで、ワークスペースの名前をクリックしてコンソールを開きます。
UI を使用するか、SQL コマンドを実行してカタログを登録できます。
UI
左側のナビゲーションウィンドウで、[カタログ] をクリックします。
[カタログリスト] ページで、[カタログの作成] をクリックします。
[Apache Paimon] を選択し、[次へ] をクリックします。
[metastore] を [dlf] に設定します。[カタログ名] で、目的の DLF カタログを選択します。[OK] をクリックしてカタログを作成します。
SQL コマンド
[スクリプト] エディターで、次の SQL 文を入力して実行し、カタログを作成します。
CREATE CATALOG `flink_catalog_name` WITH ( 'type' = 'paimon', 'metastore' = 'rest', 'token.provider' = 'dlf', 'uri' = 'http://cn-hangzhou-vpc.dlf.aliyuncs.com', 'warehouse' = 'dlf_test' );次の表にパラメーターを説明します。
パラメーター
説明
必須
例
type
カタログのタイプ。このパラメーターは
paimonに固定されています。はい
paimon
metastore
メタストアのタイプ。このパラメーターは
restに固定されています。はい
rest
token.provider
トークンプロバイダー。このパラメーターは
dlfに固定されています。はい
dlf
uri
DLF REST カタログサーバーにアクセスするための URI。フォーマットは
http://[region-id]-vpc.dlf.aliyuncs.comです。リージョン ID の詳細については、「エンドポイント」をご参照ください。はい
http://cn-hangzhou-vpc.dlf.aliyuncs.com
warehouse
ウェアハウスとして使用する基盤となる DLF カタログの名前。
はい
dlf_test
-
DLF-Legacy
-
Flink ワークスペースと同じリージョンの DLF コンソールでカタログを作成します。クイックスタート。
-
開発コンソールで Paimon カタログを登録します。
オプション 1: コンソールを使用 (推奨)
-
[カタログ] ページに移動します。
-
管理ポータルにログインし、対象のワークスペースの [操作] 列にある [コンソール] をクリックします。
-
[カタログ] をクリックします。
-
-
[カタログの作成] をクリックします。[Apache Paimon] を選択し、[次へ] をクリックします。
-
[metastore] を [DLF] に設定し、[カタログ名] ドロップダウンリストから関連付ける V1.0 DLF カタログを選択します。その後、他のカタログ設定を構成します。
オプション 2: SQL を使用
[開発] > [スクリプト] の SQL エディターで、次のコマンドを実行します。
CREATE CATALOG `my-catalog` WITH ( 'type' = 'paimon', 'metastore' = 'dlf', 'warehouse' = '<warehouse>', 'dlf.catalog.id' = '<dlf.catalog.id>', 'dlf.catalog.accessKeyId' = '<dlf.catalog.accessKeyId>', 'dlf.catalog.accessKeySecret' = '<dlf.catalog.accessKeySecret>', 'dlf.catalog.endpoint' = '<dlf.catalog.endpoint>', 'dlf.catalog.region' = '<dlf.catalog.region>', 'fs.oss.endpoint' = '<fs.oss.endpoint>', 'fs.oss.accessKeyId' = '<fs.oss.accessKeyId>', 'fs.oss.accessKeySecret' = '<fs.oss.accessKeySecret>' );パラメーターの説明:
-
一般
設定項目
説明
必須
備考
my-catalog
Paimon カタログの名前。
はい
カスタム名を入力します。
type
カタログのタイプ。
はい
値は
paimonに固定されています。metastore
メタストアのタイプ。
はい
値は
dlfに固定されています。 -
OSS
設定項目
説明
必須
備考
warehouse
OSS 内のデータウェアハウスディレクトリ。
はい
フォーマットは
oss://<bucket>/<object>です。各パラメーターの説明は次のとおりです。-
bucket: ご利用の OSS バケットの名前。 -
object: データが保存されているパス。
OSS コンソールでバケットとオブジェクト名を確認します。
fs.oss.endpoint
OSS サービスのエンドポイント。
はい
-
Flink と DLF が同じリージョンにある場合は、VPC エンドポイントを使用します。それ以外の場合は、パブリックネットワークエンドポイントを使用します。
-
Paimon テーブルを OSS-HDFS に保存する場合は、
fs.oss.endpointパラメーターの値をcn-<region>.oss-dls.aliyuncs.com(例:cn-hangzhou.oss-dls.aliyuncs.com) に設定します。
fs.oss.accessKeyId
OSS に対する読み取りおよび書き込み権限を持つ Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey ID。
はい
詳細については、「リージョンとエンドポイント」および「AccessKey の作成」をご参照ください。
fs.oss.accessKeySecret
OSS に対する読み取りおよび書き込み権限を持つ Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey Secret。
はい
-
-
DLF
設定項目
説明
必須
備考
dlf.catalog.id
DLF データカタログの ID。
はい
Data Lake Formation コンソールでデータカタログの ID を確認します。
dlf.catalog.accessKeyId
DLF サービスへのアクセスに必要な AccessKey ID。
はい
詳細については、「AccessKey の作成」をご参照ください。
dlf.catalog.accessKeySecret
DLF サービスへのアクセスに必要な AccessKey Secret。
はい
詳細については、「AccessKey の作成」をご参照ください。
dlf.catalog.endpoint
DLF サービスのエンドポイント。
はい
説明Flink と DLF が同じリージョンにある場合は、VPC エンドポイントを使用します。それ以外の場合は、パブリックネットワークエンドポイントを使用します。
dlf.catalog.region
DLF が配置されているリージョン。
はい
説明リージョンが dlf.catalog.endpoint に指定されたものと同じであることを確認してください。
-
データベースの管理
[開発] > [スクリプト] の SQL エディターで、次のコマンドを実行します。
-
データベースの作成
defaultデータベースは自動的に作成されます。さらにデータベースを作成するには、次のようにします。-- my-catalog をご利用の Paimon カタログの名前に置き換えます。 USE CATALOG `my-catalog`; -- my_db を英語のカスタムデータベース名に置き換えます。 CREATE DATABASE `my_db`; -
データベースの削除
重要defaultデータベースは DLF カタログからは削除できません。ただし、Filesystem カタログからは削除できます。-- my-catalog をご利用の Paimon カタログの名前に置き換えます。 USE CATALOG `my-catalog`; -- my_db を削除したいデータベースの名前に置き換えます。 DROP DATABASE `my_db`; -- テーブルが含まれていない場合にのみデータベースを削除します。 DROP DATABASE `my_db` CASCADE; -- データベースとその中のすべてのテーブルを削除します。
テーブルの管理
テーブルの作成
テーブルスキーマの変更
テーブルの削除
カタログの表示または削除
-
管理ポータルで、対象のワークスペースの [操作] 列にある [コンソール] をクリックします。
-
[カタログ] ページで、Apache Paimon カタログを表示または削除します。
-
[カタログリスト] ページで、カタログ名とタイプを表示します。カタログ内のデータベースとテーブルを表示するには、[操作] 列の [表示] をクリックします。
-
[カタログリスト] ページで、削除するカタログの [操作] 列にある [削除] をクリックします。
説明カタログを削除しても、Flink の登録が削除されるだけです。基盤となるデータファイルは影響を受けません。アクセスを復元するには、カタログを再登録してください。
別の方法として、[開発] > [スクリプト] の SQL エディターで
DROP CATALOG <catalog name>;を入力し、コードを選択して [実行] をクリックすることもできます。
-
