Realtime Compute for Apache Flink:ローカル開発用の VS Code 拡張機能

ステップ 1： ジョブの作成

• 方法 1： ナビゲーションペインで アイコンをクリックします。[QUICK START] セクションで [Create a new deployment] をクリックします。上部に名前を入力し、Enter キーを押して拡張子が .vvp のファイルを作成します。拡張機能により、デフォルトのフィールドが設定されたジョブが生成されます。

• 方法 2： ファイルエクスプローラーで直接 .vvp 拡張子の新しいファイルを作成します。拡張機能は、ファイルにデフォルトのジョブ設定を自動入力します。

ステップ 2： ジョブの設定

UI フォームでパラメーターを直接設定できます。

ジョブ設定に慣れている場合は、左上隅の [Raw File] をクリックしてソースファイルで直接ジョブを設定できます。UI フォームでパラメーター名をクリックすると、ソースファイル内の対応する定義に移動します。

{
  "name": "test",
  "artifact": {
    "kind": "SQLSCRIPT",
    "sqlArtifact": {
      "additionalDependencies": [],
      "sqlScript": ""
    }
  },
  "deploymentTarget": {
    "mode": "PER_JOB",
    "name": "default-queue"
  },
  ...
}

• [基本]： 基本パラメーターを設定します。

  SQL ジョブ

  パラメーター	説明
  Deployment Name	デプロイメント名。
  Execution Mode	デプロイモード。ストリーミングモードの場合は STREAM、バッチモードの場合は BATCH を使用します。
  Engine Version	エンジンバージョンの詳細については、「エンジンバージョン」をご参照ください。最新の推奨バージョンを使用することを推奨します。
  Deployment Target	デプロイメントのリソースキュー。詳細については、「リソースキューの管理」をご参照ください。
  Deployment Type	SQL を選択します。
  SQL Script	[Open in external editor] をクリックしてエディターを開き、DDL と DML コードを記述します。 説明 エディターで開かれたファイルは、実際のファイルシステムには保存されない仮想ファイルです。そのため、VS Code を再度開くと、閉じていない仮想ファイルのタブに The editor could not be opened because the file was not found というエラーメッセージが表示されます。ファイルを開くには、再度 [Open in external editor] をクリックしてください。
  Additional Dependencies	ジョブで必要な追加の依存関係。ターゲットの依存関係ファイルの URI を入力します。
  Description	任意。ジョブの説明を入力します。

  JAR ジョブ

  パラメーター設定の詳細については、「JAR ジョブのデプロイ」をご参照ください。

  パラメーター	説明
  Deployment Name	デプロイメント名。
  Execution Mode	デプロイモード。ストリーミングモードの場合は STREAM、バッチモードの場合は BATCH を使用します。
  Engine Version	エンジンバージョン。詳細については、「エンジンバージョン」をご参照ください。最新の推奨バージョンを使用することを推奨します。
  Deployment Target	デプロイメントのリソースキュー。詳細については、「リソースキューの管理」をご参照ください。
  Deployment Type	ジョブのタイプ。JAR を選択します。
  JAR URI	JAR パッケージの OSS パスまたは URL。 関連する依存関係ファイルを開発コンソールの [Artifacts] または関連付けられた OSS バケットにアップロードし、対応するパスを取得していることを確認してください。
  Entry Point Class	実行するメインクラス。JAR マニフェストでメインクラスが指定されていない場合に必要です。
  Entry Point Main Arguments	メインメソッドに渡す入力引数を入力します。
  Additional Dependencies	追加の依存関係ファイルの OSS パスまたは URL を入力します。現在、ファイル名で終わる URL のみがサポートされています。 関連する依存関係ファイルを開発コンソールの [Artifacts] または関連付けられた OSS バケットにアップロードし、対応するパスを取得していることを確認してください。
  Description	任意。ジョブの説明を入力します。

  Python ジョブ

  パラメーター設定の詳細については、「Python ジョブのデプロイ」をご参照ください。

  パラメーター	説明
  Deployment Name	デプロイメント名。
  Execution Mode	デプロイモード。ストリーミングモードの場合は STREAM、バッチモードの場合は BATCH を使用します。
  Engine Version	エンジンバージョン。詳細については、「エンジンバージョン」をご参照ください。最新の推奨バージョンを使用することを推奨します。
  Deployment Target	デプロイメントのリソースキュー。詳細については、「リソースキューの管理」をご参照ください。
  Deployment Type	ジョブのタイプ。Python を選択します。
  Python URI	Python ジョブファイルの URI。.py または .zip ファイルを指定できます。
  Entry Module	実行するエントリーモジュール。 .py ファイルの場合は不要です。 .zip ファイルの場合は必須です。
  Entry Point Main Arguments	メインメソッドに渡す入力引数を入力します。
  Python Libraries	サードパーティの Python パッケージ。これらのパッケージは Python ワーカープロセスの PYTHONPATH に追加され、Python ユーザー定義関数から直接アクセスできるようになります。サードパーティの Python パッケージの使用方法については、「サードパーティ Python パッケージの使用」をご参照ください。
  Python Archives	アーカイブファイル。詳細については、「カスタム Python 仮想環境の使用」および「データファイルの使用」をご参照ください。
  Additional Dependencies	追加の依存関係ファイルの OSS パスまたは URL を入力します。 関連する依存関係ファイルを開発コンソールの [Artifacts] または関連付けられた OSS バケットにアップロードし、対応するパスを取得していることを確認してください。
  Description	任意。ジョブの説明を入力します。

• [リソース]： ジョブのリソースパラメーターの詳細については、「ジョブリソースの設定」をご参照ください。

• [パラメーター]： ジョブの実行パラメーターの詳細については、「ランタイムパラメーターの設定」をご参照ください。

ステップ 3： ジョブのデプロイ

ジョブの開発または設定が完了したら、下部にある [Create] をクリックして新しいジョブをデプロイするか、[Update] をクリックして既存のローカルジョブを更新してデプロイします。

SQL ジョブの場合、拡張機能は SQL スクリプト、リソースプラン、その他の設定を検証し、検証結果を出力します。

ステップ 4： ジョブの開始

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

ステップ 5： ジョブ O&M

ジョブがデプロイされて実行中になると、エディター上部のアクションバーに緑色の [RUNNING] ステータスが表示されます。[Basic] エリアには、Deployment ID、Deployment Name、Execution Mode、Engine Version (例： vvr-8.0.7-flink-1.17)、Deployment Target、Deployment Type などの主要なデプロイ情報が表形式で表示されます。

• [Open Online]： [Open Online] をクリックして開発コンソールのジョブ O&M ページを開き、実行ステータスの表示や O&M 操作を実行できます。

• [同期]： クラウドからジョブ設定をプルします。[Synchronize] をクリックすると、オンライン設定のプレビューが表示されます。注意： プレビューには、コンソールで SQL ジョブに加えられた下書きの変更は含まれません。Accept をクリックして、オンライン設定でローカルファイルを 上書き します。

• [停止]： 実行中のジョブを停止します。