Query Editor UI ガイド

Query Editor は、Adobe Experience Platform Query Service が提供するインタラクティブなツールで、Experience Platform ユーザーインターフェイス内でカスタマーエクスペリエンス(顧客体験)データのクエリを記述、検証および実行できます。Query Editor では、分析およびデータ調査のためのクエリを開発できます。また、開発目的でインタラクティブクエリを実行できるほか、非インタラクティブクエリを実行して Experience Platform のデータセットに入力することもできます。

Query Service の概念と機能について詳しくは、クエリサービスの概要を参照してください。Platform 上でクエリサービスのユーザーインターフェイスを操作する方法について詳しくは、クエリサービス UI の概要を参照してください。

はじめに

Query Editor では、Query Service に接続することでクエリを柔軟に実行できます。クエリは、この接続がアクティブなときにのみ実行されます。

Query Service への接続

Query Editor を開くと、初期化と Query Service への接続に数秒かかります。クエリサービスに接続されると、コンソールに表示されます(以下を参照)。エディターがクエリサービスに接続される前にクエリを実行しようとすると、接続が完了するまで実行が待機されます。

初回接続時のクエリエディターのコンソール出力

Query Editor からのクエリの実行方法

Query Editor から実行されるクエリはインタラクティブに実行されます。つまり、ブラウザーを閉じたり、別の場所に移動したりすると、クエリはキャンセルされます。また、クエリ出力からデータセットを生成するために実行するクエリも同様です。

Query Editor を使用したクエリオーサリング

Query Editor を使用すると、顧客体験データのクエリを記述、実行および保存できます。Query Editor で実行または保存されたすべてのクエリは、Query Service にアクセスできる組織内のすべてのユーザーが利用できます。

Query Editor へのアクセス

Experience Platform UI で、左側のナビゲーションメニューの「クエリ」を選択して、Query Service ワークスペースを開きます。次に、画面の右上にある「クエリを作成」を選択して、クエリの記述を開始します。このリンクは、Query Service ワークスペースのどのページからも利用できます。

「クエリを作成」がハイライト表示された「クエリワークスペースの概要」タブ

クエリの記述

クエリエディターは、クエリをできるだけ簡単に記述できるように構成されています。次のスクリーンショットは、UI でエディターがどのように表示されるかを示しています。ここでは、SQL 入力フィールドと「再生」がハイライト表示されています。

SQL 入力フィールドと「再生」がハイライト表示されたクエリエディター

開発時間を最小限に抑えるために、返される行を制限してクエリを開発することをお勧めします。たとえば、SELECT fields FROM table WHERE conditions LIMIT number_of_rows のように設定します。クエリが目的どおりの出力を生成することを確認したら、制限を解除して、CREATE TABLE tablename AS SELECT と設定してクエリを実行し、データセットを生成します。

Query Editor の記述ツール

  • 構文の自動ハイライト表示: SQL の読み取りと構成が容易になります。

構文カラーハイライト表示の例を示すクエリエディター内の SQL ステートメント

  • SQL キーワードのオートコンプリート:​クエリの入力を開始し、矢印キーを使用して目的の用語に移動して、Enter キーを押します。

クエリエディターで SQL を数文字入力するとオートコンプリートドロップダウンメニューに選択肢が表示される様子

  • テーブルとフィールドのオートコンプリートSELECT 元のテーブル名の入力を開始し、矢印キーを使用して目的の表に移動して、Enter キーを押します。テーブルを選択すると、オートコンプリートによってそのテーブルのフィールドが認識されます。

クエリエディターに入力するとドロップダウンにテーブル名の候補が表示される様子

(限定的なリリース)オートコンプリート UI 設定切り替え

重要

オートコンプリート UI 設定の切り替えは、現在、限られたリリースになっており、すべてのお客様が利用できるわけではありません。

Query Editor では、クエリの記述時に、可能性のある SQL キーワードとテーブル名または列名の候補を自動的に表示します。オートコンプリート機能はデフォルトで有効になっており、クエリエディターの右上にある構文のオートコンプリートを切り替えることで、いつでも無効または有効にすることができます。

オートコンプリートの設定はユーザーごとに行われ、そのユーザーが次にログインしたときも記憶されています。

構文のオートコンプリート切り替えがハイライト表示されたクエリエディター

この機能を無効にすると、いくつかのメタデータコマンドが処理されなくなり、クエリの編集時に作成者のスピードアップにつながる推奨事項が提案されます。

切り替えスイッチを使用してオートコンプリート機能を有効にすると、短い一時停止の後、テーブル名や列名の推奨候補や SQL キーワードを使用できるようになります。 クエリエディターの下部のコンソールに表示される成功メッセージは、この機能がアクティブであることを示します。

オートコンプリート機能を無効にした場合は、ページを更新して設定を反映させる必要があります。 構文のオートコンプリート切り替えを無効にすると、3 つのオプションを含んだ確認ダイアログが表示されます。

  • キャンセル
  • 変更を保存して更新
  • 変更を保存せずに更新
重要

この機能を無効にしてクエリを記述または編集する場合、ページを更新する前にクエリに対する変更を保存する必要があります。さもないと、すべての変更が失われます。

オートコンプリート機能を無効にするための確認ダイアログ。

オートコンプリート機能を無効にするには、適切なオプションを選択します。

エラーの検出

Query Editor は、クエリを記述する際に自動的に検証を行い、汎用 SQL 検証と特定の実行検証を行ないます。以下の画像のように、クエリの下に赤い下線が表示される場合は、クエリ内にエラーがあります。

SQL を赤で下線付きで表示するクエリエディター入力は、エラーを示します。

エラーが検出された場合、SQL コードの上にカーソルを置くと、特定のエラーメッセージが表示されます。

エラーメッセージを含むダイアログ。

クエリの詳細

「テンプレート」タブから保存済みのテンプレートを選択して、クエリエディターで表示します。クエリの詳細パネルには、選択したクエリを管理する詳細情報とツールが表示されます。

クエリの詳細パネルがハイライト表示されたクエリエディター。

このパネルを使用すると、UI から直接出力データセットを生成し、表示されたクエリを削除または名前付け、クエリにスケジュールを追加できます。

このパネルには、クエリの最終変更日時や最終変更者(該当する場合)などの有効なメタデータも表示されます。データセットを生成するには、「データセットを出力」を選択します。データセットを出力​ダイアログが表示されます。名前と説明を入力し、「クエリを実行」を選択します。Platform で Query Service ユーザーインターフェイスの「データセット」タブに、新しいデータセットが表示されます。

スケジュール済みクエリ

テンプレートとして保存されたクエリは、クエリエディターでスケジュールできます。 これにより、カスタムケイデンスでのクエリの実行を自動化できます。 頻度、日付、時刻に基づいてクエリをスケジュールし、必要に応じて結果の出力データセットを選択することもできます。 クエリスケジュールは、UI で無効にしたり削除したりすることもできます。

スケジュールは、クエリエディターで設定します。次に、クエリエディターを使用する場合のスケジュールされたクエリの制限事項を示します。これらは、 Query Service API:

  • 既に作成、保存、実行されたクエリにのみスケジュールを追加できます。
  • パラメーター化クエリにスケジュールを追加することは​できません
  • スケジュールされたクエリに匿名ブロックを含めることは​できません

方法については、クエリスケジュールのドキュメントを参照してください UI でのクエリスケジュールの作成. また、API を使用してスケジュールを追加する方法については、 スケジュール済みクエリエンドポイントガイド.

スケジュールされたクエリは、 スケジュールクエリ タブをクリックします。 そのワークスペースから、UI を使用して、スケジュールされたすべてのクエリジョブのステータスを監視できます。 の スケジュールクエリ タブでは、クエリの実行に関する重要な情報を確認し、アラートを購読できます。 使用可能な情報には、ステータス、スケジュールの詳細、実行が失敗した場合のエラーメッセージ/コードなどが含まれます。 詳しくは、 スケジュールクエリドキュメントの監視 を参照してください。

クエリの保存

Query Editor にはクエリを保存して後で作業できる保存機能があります。クエリを保存するには、Query Editor の右上隅にある「保存」を選択します。クエリを保存する前に、クエリの詳細​パネルを使用してクエリに名前を付ける必要があります。

メモ

クエリエディターを使用してで名前を付けて保存したクエリは、クエリダッシュボードの「テンプレート」タブ内でテンプレートとして使用できます。 詳しくは、テンプレートのドキュメントを参照してください。

以前のクエリを検索する方法

Query Editor で実行したクエリはすべて「ログ」テーブルに保存されます。「ログ」タブの検索機能を使用して、クエリの実行を検索できます。保存したクエリは「テンプレート」タブに表示されます。

クエリがスケジュールされている場合、「スケジュールされたクエリ」タブでは、UI を使用してこれらのクエリジョブをより明確に表示できます。 詳しくは、クエリ監視のドキュメントを参照してください。

メモ

実行されなかったクエリは「ログ」に保存されません。クエリを Query Service で使用できるようにするには、Query Editor でクエリを実行するか保存する必要があります。

クエリエディターを使用してクエリを実行する

Query Editor でクエリを実行するには、エディターに SQL を入力するか、「ログ」タブまたは「テンプレート」タブから以前のクエリを読み込み、「再生」を選択します。クエリ実行のステータスは下の「コンソール」タブに表示され、出力データは「結果」タブに表示されます。

コンソール

コンソールには、Query Service のステータスと処理に関する情報が表示されます。コンソールには、Query Service への接続状態、実行中のクエリ操作、およびこれらのクエリによるエラーメッセージが表示されます。

クエリエディターコンソールの「コンソール」タブ

メモ

コンソールには、クエリの実行時に発生したエラーのみが表示されます。クエリを実行する前に、クエリ検証エラーは表示されません。

クエリの結果

クエリが完了すると、結果が「コンソール」タブの横の「結果」タブに表示されます。このビューには、クエリの出力が表形式で出力され、最大 100 行まで表示されます。このビューを使用すると、クエリが目的どおりの出力を生成することを確認できます。クエリでデータセットを生成するには、返される行の制限を解除し、CREATE TABLE tablename AS SELECT と設定してクエリを実行します。Query Editor でクエリの結果からデータセットを生成する方法については、データセットの生成についてのチュートリアルを参照してください。

クエリ実行の結果を表示するクエリエディターコンソールの「結果」タブ

Query Service チュートリアルビデオを使用したクエリの実行

次のビデオでは、Adobe Experience Platform インターフェイスおよび PSQL クライアントでクエリを実行する方法を説明します。 また、XDM オブジェクト内での個々のプロパティの使用方法、アドビ定義関数の使用方法、CREATE TABLE AS SELECT(CTAS)の使用方法も説明します。

次の手順

Query Editor で使用できる機能とアプリケーションの操作方法について説明しました。これで、独自のクエリを Platform で直接記述できます。Data Lake のデータセットに対して SQL クエリを実行する方法については、クエリの実行に関するガイドを参照してください。

このページ