Query Editor UI ガイド

最終更新日: 2023-11-06
  • トピック:
  • Queries
    このトピックの詳細を表示
  • 作成対象:
  • Developer
    User
    Admin
    Leader

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

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

メモ

一部のクエリサービス機能は、従来のバージョンのクエリエディターでは提供されていません。 このドキュメントで使用するスクリーンショットは、特に記載がない限り、クエリエディターの拡張バージョンを使用して撮影します。 詳しくは、 クエリエディターの強化 を参照してください。

はじめに

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

Query Editor へのアクセス

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

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

Query Service への接続

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

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

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

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

クエリエディターの拡張版を使用すると、クエリエディターで複数のクエリを記述し、すべてのクエリを順番に実行できます。 詳しくは、 複数の順次クエリの実行 を参照してください。

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

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

重要

従来のエディターは 2024 年 4 月 1 日に廃止され、使用できなくなります。

クエリエディターの切り替え機能の強化

「UI」切り替えを使用して、クエリエディターのレガシーバージョンと拡張バージョンを切り替えることができます。 レガシーバージョンはデフォルトで有効になっていますが、拡張バージョンはアクセシビリティと複数テーマのサポートを強化します。拡張バージョンを有効にして、クエリエディター設定にアクセスします。

拡張クエリエディター切り替えがハイライト表示されたクエリエディター。

切り替えを有効にすると、エディターが明るいテーマに切り替わり、構文の読みやすさが向上します。 また、オートコンプリート切り替えを組み込むクエリエディター入力フィールドの上に設定アイコンが表示されます。 設定アイコンから、ダークテーマを有効にしたり、オートコンプリートを無効/有効にしたりできます。

ヒント

拡張されたクエリエディターを使用すると、次の操作を実行できます。 構文のオートコンプリートを無効にする クエリの作成中に進行状況が失われることはありません。 通常、編集中にオートコンプリート機能を無効にすると、クエリに対するすべての変更が失われます。

暗いテーマまたは明るいテーマを有効にするには、設定アイコン (設定アイコン。) に続いて、表示されるドロップダウンメニューのオプションが表示されます。

設定アイコンと「ダークテーマを有効にする」ドロップダウンメニューオプションがハイライトされたクエリエディター。

複数の順次クエリを実行

クエリエディターの拡張版を使用すると、クエリエディターで複数のクエリを記述し、すべてのクエリを順番に実行できます。

1 つのシーケンスで複数のクエリを実行すると、それぞれログエントリが生成されます。 ただし、最初のクエリの結果のみがクエリエディターコンソールに表示されます。 実行されたクエリのトラブルシューティングや確認が必要な場合は、クエリログを確認します。 詳しくは、 クエリログドキュメント を参照してください。

メモ

クエリエディターで最初のクエリの後に CTAS クエリが実行された場合でも、テーブルは作成されますが、クエリエディターコンソールには出力はありません。

選択したクエリを実行

複数のクエリを記述したが、1 つのクエリのみを実行する必要がある場合は、選択したクエリをハイライト表示し、
選択したクエリを実行 アイコン。 このアイコンは、エディターでクエリを選択しない限り、デフォルトでは無効になっています。

クエリエディターと 選択したクエリを実行 アイコンがハイライト表示されます。

結果数

クエリエディターには、最大 50,000 行の出力があります。 ただし、クエリエディターコンソールには、一度に 50 行のみが表示されます。 コンソールに表示される行数を変更するには、 結果数 ドロップダウンを開き、50、100、150、300、500 の値から選択します。

結果数ドロップダウンがハイライト表示されたクエリエディター。

クエリの記述

クエリエディターは、クエリをできるだけ簡単に記述できるように構成されています。次のスクリーンショットは、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 キーを押します。テーブルを選択すると、オートコンプリートはそのテーブルのフィールドを認識します。

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

テキストの書式設定

The テキストの書式設定 機能により、標準化された構文スタイルを追加することで、クエリがより読みやすくなります。 選択 テキストの書式設定 を使用して、クエリエディター内のすべてのテキストを標準化します。

クエリエディターと テキストの書式設定 ハイライト表示された SQL 文

SQL をコピー

コピーアイコンを選択して、クエリエディターからクリップボードに SQL をコピーします。 このコピー機能は、クエリテンプレートと、クエリエディターで新しく作成されたクエリの両方で使用できます。

クエリワークスペースには、コピーアイコンが強調表示されたクエリテンプレートの例が表示されています。

オートコンプリート 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 オブジェクト内の個々のプロパティの使用、Adobe定義関数、CREATE TABLE AS SELECT(CTAS) クエリの使用方法についても説明します。

次の手順

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

このページ