クエリエディター UI ガイド

NOTE
従来のエディターは、2024 年 5 月 24 日(PT)に非推奨(廃止予定)となりました。 使用するためにアクセスできなくなりました。 拡張クエリエディターを使用して、クエリの書き込み、検証および実行ができるようになりました

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

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

はじめに getting-started

クエリエディターでは、クエリサービスに接続することでクエリを柔軟に実行できます。クエリは、この接続がアクティブなときにのみ実行されます。

クエリエディターへのアクセス accessing-query-editor

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

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

クエリサービスへの接続 connecting-to-query-service

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

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

クエリエディターからのクエリの実行 run-a-query

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

拡張クエリエディターを使用したクエリオーサリング query-authoring

NOTE
従来のエディターは、2024 年 5 月 24 日(PT)に非推奨(廃止予定)となりました。 使用するためにアクセスできなくなりました。 拡張クエリエディターを使用して、クエリの書き込み、検証、実行ができるようになりました。

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

設定 settings

クエリエディター入力フィールドの上にある設定アイコンには、ダークテーマを有効/無効にするオプションや、オートコンプリートを無効/有効にするオプションが含まれています。

TIP
クエリの作成中に進行状況を維持しながら ​ 構文のオートコンプリートを無効にする ​ ことができます。

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

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

オートコンプリート auto-complete

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

オートコンプリートの設定はユーザーごとに行われ、そのユーザーが次にログインしたときも記憶されています。 この機能を無効にすると、いくつかのメタデータコマンドが処理されなくなり、クエリの編集時に作成者のスピードアップにつながるレコメンデーションが提案されます。

複数の順次クエリの実行 execute-multiple-sequential-queries

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

NOTE
クエリエディターで最初のクエリを実行した後に CTAS クエリを実行すると、テーブルは作成されますが、クエリエディターコンソールには出力されません。

選択したクエリの実行 execute-selected-query

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

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

クエリエディターセッションをキャンセル cancel-query

長時間実行されるクエリをキャンセルすることで、クエリの実行を制御し、生産性を向上させます。 このアクションは、クエリの実行中にクエリエディターをクリアします。 クエリは引き続きバックグラウンドで実行されることに注意してください。 CTAS クエリの場合でも、出力データセットが生成されます。 エディターでの実行をキャンセルして SQL 文の作成を続行するには、クエリを実行した後で クエリをキャンセル を選択します。

「クエリをキャンセル がハイライト表示され クエリエディター

確認ダイアログが表示されます。 「確認」を選択して、クエリの実行をキャンセルします。

「確認」がハイライト表示されたクエリ確認をキャンセルダイアログ

結果数 result-count

クエリエディターの出力行は最大 50,000 行です。 クエリエディターコンソールに一度に表示する行数を選択できます。 コンソールに表示される行数を変更するには、「結果数」ドロップダウンを選択し、50、100、150、300、500 の各オプションから選択します。

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

クエリの記述 writing-queries

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

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

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

クエリエディターの記述ツール writing-tools

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

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

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

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

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

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

テキストを書式設定 format-text

​ テキストを書式設定 ​ 機能は、標準化された構文スタイルを追加することで、クエリをわかりやすくします。 「テキストを書式設定」を選択して、クエリエディター内のすべてのテキストを標準化します。

NOTE
​ テキストの書式設定 ​ 機能は、匿名ブロックでは機能しません。 1 つ以上の SQL 文を順番に連結する方法については、 匿名ブロックのドキュメントを参照してください。

「テキストの形式 とハイライト表示された SQL 文を含むクエリエディター 表示されます。

SQL をコピー copy-sql

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

コピーアイコンがハイライト表示されたサンプルクエリテンプレートを含むクエリワークスペース。

クエリの詳細 query-details

クエリエディターでクエリを表示するには、「​ テンプレート ​」タブから保存済みのテンプレートを選択します。 クエリの詳細パネルには、選択したクエリを管理するための詳細情報とツールが表示されます。 また、クエリの最終変更日時や最終変更者(該当する場合)などの便利なメタデータも表示されます。

NOTE
​ スケジュールを表示 ​、​ スケジュールを追加 ​ および ​ クエリを削除 ​ オプションは、クエリがテンプレートとして保存された後でのみ使用できます。 「​ スケジュールを追加 ​」オプションを選択すると、クエリエディターからスケジュールビルダーに直接移動します。 「​ スケジュールの表示 ​」オプションを選択すると、そのクエリのスケジュール在庫に直接移動します。 UI でクエリスケジュールを作成する方法については、クエリスケジュールのドキュメントを参照してください。

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

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

出力データセットを生成するには、「CTAS として実行 を選択します。 出力データセットの詳細を入力 ダイアログが表示されます。 名前と説明を入力し、「CTAS として実行」を選択します。 新しいデータセットが データセット 「参照」タブに表示されます。 組織で使用可能なデータセットについて詳しくは、 データセットの表示に関するドキュメントを参照してください。

NOTE
「CTAS として実行 ​」オプションは、クエリがスケジュールされている されていない 場合にのみ使用できます。

出力データセットの詳細を入力 ダイアログ

CTAS として実行 アクションを実行すると、確認メッセージがポップアップ表示され、アクションが成功したことが通知されます。 このポップアップメッセージには、クエリログワークスペースに移動するのに便利な方法を提供するリンクが含まれています。 クエリログについて詳しくは、 クエリログドキュメントを参照してください。

クエリの保存 saving-queries

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

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

クエリエディターでクエリを保存すると、確認メッセージがポップアップ表示され、アクションが成功したことが通知されます。 このポップアップメッセージには、クエリスケジュールワークスペースに移動する便利な方法を提供するリンクが含まれています。 カスタムケイデンスでクエリを実行する方法については、 クエリのスケジュール設定ドキュメントを参照してください。

スケジュール済みクエリ scheduled-queries

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

スケジュールは、クエリエディターで設定します。 クエリエディターを使用する場合、既に作成および保存されたクエリにのみスケジュールを追加できます。 Query Service API にも同じ制限は適用されません。

NOTE
10 回連続して実行されなかったスケジュール済みクエリは、自動的に ​ 強制隔離 ​ ステータスになります。 このステータスのクエリを実行するには、それ以上の実行を行う前に介入が必要です。 詳しくは、 強制隔離されたクエリのドキュメントを参照してください。

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

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

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

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

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

NOTE
実行されなかったクエリは「ログ」に保存されません。クエリをクエリサービスで使用するには、クエリエディターでクエリを実行するか保存する必要があります。

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

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

コンソール console

コンソールには、クエリサービスのステータスと処理に関する情報が表示されます。コンソールには、クエリサービスへの接続ステータス、実行中のクエリ処理、およびこれらのクエリの実行時に発生したエラーメッセージが表示されます。

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

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

クエリの結果 query-results

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

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

ユースケース use-cases

クエリサービスは、業界やビジネスシナリオをまたいだ様々なユースケースに対するソリューションを提供します。 これらの実例は、サービスが多様なニーズに対応する上で柔軟性と効果を発揮していることを示しています。 クエリサービスが特定のビジネスニーズにどのように価値をもたらすことができるかを明らかにするには、ユースケースに関するドキュメントの包括的なコレクションを参照してください。 クエリサービスを使用して、運用効率とビジネス成功を強化するためのインサイトとソリューションを提供する方法を説明します。

クエリサービスを使用したクエリの実行のチュートリアルビデオ query-tutorial-video

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

NOTE
ビデオに表示されている UI は古くなっていますが、ワークフローで使用されるロジックは変わりません。

次の手順

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

recommendation-more-help
ccf2b369-4031-483f-af63-a93b5ae5e3fb