Realtime Compute for Apache Flink の VS Code 拡張機能は、Flink ジョブのローカル開発プロセスを効率化します。この拡張機能を使用すると、ローカルマシンから SQL、JAR、Python ジョブを開発、デプロイ、公開できます。また、オンライン環境からジョブ構成を同期することもできます。このトピックでは、VS Code 拡張機能の使用方法について説明します。
前提条件
AccessKey ID と AccessKey Secret を取得済みであること。AccessKey に関連付けられた ID には、対象プロジェクトに対する必要な権限が付与されている必要があります。詳細については、「AccessKey ID と AccessKey Secret の確認方法」および「開発コンソールでのユーザーへの権限付与」をご参照ください。
VS Code エディター v1.74.0 以降がインストール済みであること。VS Code は VS Code 公式サイト からダウンロードできます。
制限事項
ログ構成はサポートされていません。
既存のオンラインジョブのプルはサポートされていません。
拡張機能のインストールと構成
拡張機能をダウンロードしてインストールします。
方法 1：VSCode Marketplace にアクセスし、[インストール] をクリックします。
方法 2：
VS Code を開き、左側のナビゲーションウィンドウで [EXTENSIONS] をクリックします。
検索バーで、Flink Realtime Compute Studio 拡張機能を検索します。
対象の拡張機能の [インストール] をクリックします。
メニューバーで をクリックし、ローカルフォルダーを選択します。
AccessKey 情報を設定します。
現在のワークスペース (現在のファイルディレクトリ) への適用
左側のナビゲーションウィンドウで
をクリックします。[AK&SK の設定] セクションで、[.vvprc ファイルで設定] をクリックします。拡張機能により、.vvprc拡張子のファイルが自動的に作成されます。
次の構成情報を入力します。
{ "accessKey": "xxx", "secretKey": "xxx", "namespace": "xxx", "workspace": "xxx", "regionId" : "xxx" }パラメーター
説明
注意
accessKey
Alibaba Cloud アカウントの AccessKey ID。
詳細については、「AccessKey ID と AccessKey Secret の確認方法」をご参照ください。
secretKey
Alibaba Cloud アカウントの AccessKey Secret。
namespace
Flink プロジェクトの名前。
詳細については、「プロジェクトの表示と削除」をご参照ください。
workspace
Flink ワークスペースの ID。
詳細については、「ワークスペース ID などの情報の表示方法」をご参照ください。
regionId
リージョン ID。
エンドポイントでリージョン ID をご参照ください。
グローバルな適用
左側のナビゲーションウィンドウで
をクリックします。[AK&SK の設定] セクションで、[グローバルユーザー設定で構成] をクリックします。VS Code のグローバル設定にリダイレクトされます。
必要に応じて [ユーザー] または [ワークスペース] を選択して設定を構成します。
説明[ユーザー] の設定は VS Code エディター内のすべてのプロジェクトとワークスペースに適用され、グローバル構成ファイルに保存されます。[ワークスペース] の設定は、現在開いているワークスペースにのみ適用されます。
パラメーター
説明
注意
アクセスキー
Alibaba Cloud アカウントの AccessKey ID。
詳細については、「AccessKey ID と AccessKey Secret の確認方法」をご参照ください。
シークレットキー
Alibaba Cloud アカウントの AccessKey Secret。
詳細については、「AccessKey ID と AccessKey Secret の確認方法」をご参照ください。
名前空間
Flink プロジェクトの名前。
詳細については、「プロジェクトの表示と削除」をご参照ください。
ワークスペース
Flink ワークスペースの ID。
詳細については、「ワークスペース ID などの情報の表示方法」をご参照ください。
リージョン ID
リージョン ID。
エンドポイントでリージョン ID をご参照ください。
説明設定の優先順位：現在のフォルダーの設定 > 親フォルダーの設定 > グローバル設定。
設定が適用されると、対応するプロジェクトの名前がジョブエディターの下部にあるステータスバーに表示されます。
(任意) 次の拡張機能をインストールすると、コーディング効率を向上させることができます。
Flink SQL：Flink SQL Language Features 拡張機能をインストールします。この拡張機能は Flink SQL 言語サービスを提供し、完全な Flink SQL 構文をサポートします。
Flink 構成：YAML VS Code 拡張機能をインストールします。この拡張機能は、Flink 構成の自動補完機能を提供します。
操作手順
ステップ 1：ジョブの作成
方法 1: 左側のナビゲーションウィンドウで
をクリックします。[クイックスタート] セクションで、[新しいデプロイメントの作成] をクリックします。上部に名前を入力して Enter キーを押し、.vvp拡張子のファイルを作成します。拡張機能により、デフォルトのフィールドを持つジョブが生成されます。
方法 2：ファイルツリーで
.vvp拡張子のファイルを作成します。拡張機能はデフォルトフィールドを持つジョブを生成します。
ステップ 2：ジョブの設定
UI フォームでパラメーターを設定します。
ジョブの設定に慣れている場合は、左上隅の [Raw File] ボタンをクリックして、ソースファイルでジョブを設定できます。UI フォームでは、パラメーター名をクリックすると、ソースファイル内の対応する場所に移動できます。
基本：基本的なパラメーター設定
リソース：ジョブリソースパラメーターの詳細については、「ジョブリソースの設定」をご参照ください。
パラメーター：ジョブ実行パラメーターの詳細については、「実行パラメーターの設定」をご参照ください。
ステップ 3：ジョブのデプロイ
ジョブを設定した後、ページ下部の [作成] をクリックして新しいジョブとしてデプロイします。既存のローカルジョブの場合は、[更新] をクリックして変更をデプロイします。
SQL ジョブの場合、拡張機能は SQL スクリプト、リソースプラン、およびその他のジョブ構成を検証し、検証結果を表示します。
ステップ 4：ジョブの開始
デプロイされたジョブの場合、最新のステータスが右上隅に表示されます。[開始] をクリックして起動状態を選択できます。起動状態の詳細については、「ジョブの開始」をご参照ください。
ステップ 5：ジョブの O&M の実行
オンラインで開く：ジョブの詳細な実行ステータスを表示したり、O&M 操作を実行したりするには、左上隅の [オンラインで開く] をクリックします。Flink 開発コンソールの O&M ページにリダイレクトされます。
同期：このオプションは、オンライン環境からジョブを同期します。[同期] をクリックして、オンラインジョブのプレビューページを開きます。プレビューページには、コンソールで SQL ジョブに加えられたドラフト更新は表示されません。プレビューが正しいことを確認した後、右上隅の
Acceptボタンをクリックします。その後、拡張機能はローカルジョブファイルをオンラインジョブで上書きします。キャンセル：ジョブを終了します。
参照
サポートされているコネクタの詳細については、「サポートされているコネクタ」をご参照ください。
Flink JAR ジョブの開発とデバッグの詳細については、「JAR ジョブの開発」をご参照ください。
Flink Python ジョブの開発とデバッグの詳細については、「Python ジョブの開発」をご参照ください。
Flink SQL ジョブのパフォーマンスを向上させるには、「高パフォーマンス Flink SQL 最適化テクニック」をご参照ください。