Realtime Compute for Apache Flink:Visual Studio Code 拡張機能を使用する

前提条件

• ワークスペースが作成されていること。 詳細については、「Realtime Compute for Apache Flink をアクティブ化する」をご参照ください。

• AccessKey ID と AccessKey Secret を取得し、使用する名前空間に関連する権限が付与されていること。 詳細については、「アカウントの AccessKey ペアを表示する方法」および「名前空間に対する権限を付与する」をご参照ください。

• Visual Studio Code 1.74.0 以降がインストールされていること。 詳細については、Visual Studio Code の Web サイトをご覧ください。

制限事項

• 拡張機能はログ構成をサポートしていません。

• 拡張機能は、Realtime Compute for Apache Flink の開発コンソールで作成されたデプロイを同期できません。

拡張機能のインストールと構成

1. 拡張機能をダウンロードしてインストールします。

   • 方法 1：Visual Studio Code Marketplace ページに移動し、[インストール] をクリックします。

   • 方法 2：

     1. コンピューターで Visual Studio Code を開きます。 左側のナビゲーションペインで、[拡張機能] をクリックします。

     2. 検索ボックスに Flink Realtime Compute Studio と入力します。

     3. 一致する拡張機能を見つけて、[インストール] をクリックします。

2. トップナビゲーションバーで、[ファイル] > [フォルダーを開く] を選択し、使用するフォルダーを選択します。

3. AccessKey ペアを構成します。

   現在のフォルダーのみに構成する

   1. 左側のナビゲーションペインで、 をクリックします。 [AK&SK の構成] セクションで、[.vvprc ファイルに構成する] をクリックします。 拡張機能は、.vvprc で終わるファイルを自動的に作成します。

      

   2. 作成されたファイルを開き、次の構成を追加します。

      {
        "accessKey": "xxx",
        "secretKey": "xxx",
        "namespace": "xxx",
        "workspace": "xxx",
        "regionId" : "xxx"
      }

      パラメーター	説明	参照
      accessKey	Alibaba Cloud アカウントの AccessKey ID。	アカウントの AccessKey ペアを表示する方法
      secretKey	Alibaba Cloud アカウントの AccessKey Secret。
      namespace	使用する Realtime Compute for Apache Flink 名前空間の名前。	名前空間の表示と削除
      workspace	使用する Realtime Compute for Apache Flink ワークスペースの ID。	ワークスペース ID などのワークスペースに関する情報を表示する方法
      regionId	ワークスペースが作成されているリージョンの ID。	エンドポイント

   現在のワークスペースまたはユーザーに構成する

   1. 左側のナビゲーションペインで、 をクリックします。

   2. [AK&SK の構成] セクションで、[グローバルユーザー設定に構成する] をクリックして、Visual Studio Code の設定エディターを開きます。

      

   3. ビジネス要件に基づいて、[ユーザー] タブまたは [ワークスペース] タブを選択します。

      説明

      [ユーザー] タブを選択することをお勧めします。 こうすることで、パラメーター構成は Visual Studio Code のすべてのプロジェクトとワークスペースに適用されます。

      パラメーター	説明	参照
      アクセスキー	Alibaba Cloud アカウントの AccessKey ID。	アカウントの AccessKey ペアを表示する方法
      シークレットキー	Alibaba Cloud アカウントの AccessKey Secret。	アカウントの AccessKey ペアを表示する方法
      名前空間	使用する Realtime Compute for Apache Flink 名前空間の名前。	名前空間の表示と削除
      ワークスペース	使用する Realtime Compute for Apache Flink ワークスペースの ID。	ワークスペース ID などのワークスペースに関する情報を表示する方法
      リージョン ID	ワークスペースが作成されているリージョンの ID。	エンドポイント

   説明

   構成の優先順位：現在のフォルダーの構成 > ワークスペースの構成 > ユーザーの構成。

   構成が有効になると、Realtime Compute for Apache Flink 名前空間の名前が、コードエディターの下部にあるステータスバーに表示されます。

4. (オプション) コーディング効率を向上させるために、次の拡張機能をインストールします。

   • Flink SQL Language Features: Apache Flink SQL の構文をサポートします。

   • YAML VS Code: Realtime Compute for Apache Flink に関連する構成のインラインコード補完を提供します。

拡張機能の使用

ステップ 1：デプロイを作成する

• 方法 1：左側のナビゲーションペインで、 をクリックします。 [クイックスタート] セクションで、[新しいデプロイを作成する] をクリックします。 トップナビゲーションバーに名前を入力し、Enter キーを押して、.vvp で終わるファイルを作成します。 ファイルには、事前に入力されたデプロイ構成が含まれています。

  

• 方法 2：現在のフォルダーに .vvp で終わるファイルを作成します。 ファイルには、事前に入力されたデプロイ構成が含まれています。

ステップ 2：デプロイを構成する

フォームビューでデプロイを構成できます。

パラメーターに精通している場合は、左上隅にある [raw ファイル] をクリックして、Raw ファイルビューでデプロイを構成することもできます。 フォーム内のフィールド名をクリックすると、Raw ファイル内の対応するパラメーターをすばやく見つけることができます。

• 基本: このセクションには、基本的なデプロイパラメーターが含まれています。

  SQL デプロイ

  パラメーター	説明
  デプロイ名	デプロイの名前を入力します。
  実行モード	デプロイモードを選択します。 有効な値：STREAM (ストリーミングモード) と BATCH (バッチモード)。
  エンジンバージョン	Ververica Runtime (VVR) エンジンのバージョンを選択します。 詳細については、「エンジンバージョン」をご参照ください。 RECOM のラベルが付いたバージョンを選択することをお勧めします。
  デプロイターゲット	デプロイに使用するキューを選択します。 詳細については、「キューの管理」をご参照ください。
  デプロイタイプ	デプロイのタイプを選択します。 この例では、SQL を選択します。
  SQL スクリプト	[外部エディターで開く] をクリックして、DDL ステートメントと DML ステートメントを記述できるコードエディターを開きます。 説明 コードエディターで行った変更は、仮想ファイルに保存されます。 エディターを閉じずに Visual Studio Code を終了して再度開くと、対応するエディターウィンドウに次のエラーメッセージが表示されます：ファイルが見つからないため、エディターを開くことができませんでした。 エラーを解決するには、[外部エディターで開く] をもう一度クリックします。
  追加の依存関係	デプロイに必要な追加の依存関係の URI を入力します。
  説明	オプション。 デプロイの説明を入力します。

  JAR デプロイ

  次の表にパラメーターを示します。 パラメーターの詳細な説明については、「JAR デプロイを作成する」をご参照ください。

  パラメーター	説明
  デプロイ名	デプロイの名前を入力します。
  実行モード	デプロイモードを選択します。 有効な値：STREAM (ストリーミングモード) と BATCH (バッチモード)。
  エンジンバージョン	VVR エンジンのバージョンを選択します。 詳細については、「エンジンバージョン」をご参照ください。 RECOM のラベルが付いたバージョンを選択することをお勧めします。
  デプロイターゲット	デプロイに使用するキューを選択します。 詳細については、「キューの管理」をご参照ください。
  デプロイタイプ	デプロイのタイプを選択します。 この例では、Jar を選択します。
  JAR URI	デプロイに使用する JAR パッケージの Object Storage Service (OSS) パスまたは URL を入力します。 OSS パスまたは URL を取得するには、Realtime Compute for Apache Flink の開発コンソールまたはワークスペースに関連付けられた OSS バケットの [アーティファクト] ページに JAR パッケージをアップロードしてください。
  エントリポイントクラス	Java アプリケーションのエントリポイントクラスを入力します。 JAR パッケージでメインクラスを指定しない場合は、このパラメーターをメインクラスの完全修飾クラス名に設定してください。
  エントリポイントのメイン引数	main メソッドに渡す引数を入力します。
  追加の依存関係	デプロイに必要な追加の依存関係の OSS パスまたは URL を入力します。 URL はファイル名で終わる必要があります。 OSS パスまたは URL を取得するには、Realtime Compute for Apache Flink の開発コンソールまたはワークスペースに関連付けられた OSS バケットの [アーティファクト] ページに依存関係ファイルをアップロードしてください。
  説明	オプション。 デプロイの説明を入力します。

  Python デプロイ

  次の表にパラメーターを示します。 パラメーターの詳細な説明については、「Python デプロイを作成する」をご参照ください。

  パラメーター	説明
  デプロイ名	デプロイの名前を入力します。
  実行モード	デプロイモードを選択します。 有効な値：STREAM (ストリーミングモード) と BATCH (バッチモード)。
  エンジンバージョン	VVR エンジンのバージョンを選択します。 詳細については、「エンジンバージョン」をご参照ください。 RECOM のラベルが付いたバージョンを選択することをお勧めします。
  デプロイターゲット	デプロイに使用するキューを選択します。 詳細については、「キューの管理」をご参照ください。
  デプロイタイプ	デプロイのタイプを選択します。 この例では、Python を選択します。
  Python URI	使用する Python デプロイファイルの URI を入力します。 ファイルは .py ファイルまたは .zip ファイルです。
  エントリモジュール	Python アプリケーションのエントリポイントクラスを入力します。 .py ファイルを使用する場合は、このパラメーターを空のままにします。 .zip ファイルを使用する場合は、このパラメーターを構成する必要があります。
  エントリポイントのメイン引数	main メソッドに渡す引数を入力します。
  Python ライブラリ	使用するサードパーティの Python ライブラリを入力します。 指定されたライブラリは、デプロイの対応するワーカープロセスの PYTHONPATH 環境変数に自動的に渡されます。 これにより、Python ユーザー定義関数 (UDF) でライブラリを使用できます。 サードパーティの Python ライブラリの使用方法については、「サードパーティの Python パッケージを使用する」をご参照ください。
  Python アーカイブ	使用するアーカイブファイルを入力します。 詳細については、「カスタム Python 仮想環境を使用する」および「データファイルを使用する」をご参照ください。
  追加の依存関係	デプロイに必要な追加の依存関係の OSS パスまたは URL を入力します。 OSS パスまたは URL を取得するには、Realtime Compute for Apache Flink の開発コンソールまたはワークスペースに関連付けられた OSS バケットの [アーティファクト] ページに依存関係ファイルをアップロードしてください。
  説明	オプション。 デプロイの説明を入力します。

• リソース: このセクションのパラメーターについては、「デプロイのリソースを構成する」をご参照ください。

• パラメーター: このセクションのパラメーターについては、「パラメーター」をご参照ください。

ステップ 3：デプロイを送信する

エディターの下部にある [作成] をクリックして、デプロイを送信します。 既存のデプロイを更新する場合は、[更新] をクリックして、更新されたデプロイを送信します。

SQL デプロイを送信すると、拡張機能は SQL スクリプト、リソースプラン、およびその他の構成をチェックし、チェック結果を生成します。

ステップ 4：デプロイを開始する

デプロイを送信すると、デプロイの最新のステータスが右上隅に表示されます。 [開始] をクリックして、起動モードを選択します。 起動モードの詳細については、「手順」をご参照ください。

ステップ 5：デプロイを管理する

• 詳細な実行ステータスを表示したり、O&M 操作を実行したりするには、左上隅にある [オンラインで開く] をクリックして、Realtime Compute for Apache Flink の開発コンソールにある [デプロイ] ページに移動します。

• デプロイをすばやく同期するには、[同期] をクリックしてプレビューページを開き、プレビューページで構成を確認してから、右上隅にある 承諾 をクリックします。 これにより、拡張機能は Realtime Compute for Apache Flink の開発コンソールからの構成を使用して構成を 上書き できます。 プレビューページには、コンソールで実行した SQL スクリプトの更新は表示されません。

• デプロイをキャンセルするには、右上隅にある [キャンセル] をクリックします。

参照

• Realtime Compute for Apache Flink でサポートされているコネクターについては、「サポートされているコネクター」をご参照ください。

• JAR デプロイの開発とデバッグの方法については、「JAR ドラフトを開発する」をご参照ください。

• Python デプロイの開発とデバッグの方法については、「Python API ドラフトを開発する」をご参照ください。

• SQL デプロイのパフォーマンスを向上させる方法については、「Flink SQL を最適化する」をご参照ください。