クエリエディター UI ガイド
作成対象:
- ユーザー
- 開発者
クエリエディターは、Adobe Experience Platform クエリサービスから提供されるインタラクティブなツールで、これを使用すれば、Experience Platform ユーザーインターフェイス内でカスタマーエクスペリエンス(顧客体験)データのクエリを記述、検証および実行できます。 クエリエディターでは、分析およびデータ調査のためのクエリを作成できます。また、開発目的でインタラクティブクエリを実行できるほか、非インタラクティブクエリを実行して Experience Platform のデータセットに入力することもできます。
クエリサービスの概念と機能について詳しくは、「Query Service overview」を参照してください。Experience Platform 上でクエリサービスのユーザーインターフェイスを操作する方法について詳しくは、クエリサービス UI の概要を参照してください。
はじめに
クエリエディターでは、クエリサービスに接続することでクエリを柔軟に実行できます。クエリは、この接続がアクティブなときにのみ実行されます。
クエリエディターへのアクセス
Experience Platform UI で、左側のナビゲーションメニューの クエリ を選択して、クエリサービス ワークスペースを開きます。 次に、クエリの記述を開始するには、画面の右上にある「クエリを作成」を選択します。 このリンクは、クエリサービスのワークスペースのどのページからも利用できます。
クエリサービスへの接続
クエリエディターを開くと、クエリサービスが初期化され接続されるまでに数秒かかります。 クエリサービスに接続されると、コンソールに表示されます(以下を参照)。エディターがクエリサービスに接続される前にクエリを実行しようとすると、接続が完了するまで実行が待機されます。
クエリエディターからのクエリの実行
クエリエディターから実行されるクエリはインタラクティブに実行されるので、ブラウザーを閉じたり、ブラウザーから移動したりすると、クエリがキャンセルされます。 クエリ出力からデータセットを生成するように作成されたクエリについても、同じことが言えます。
拡張クエリエディターを使用したクエリオーサリング
クエリエディターを使用して、顧客体験データのクエリを記述、実行および保存できます。クエリエディターで実行または保存されたすべてのクエリは、クエリサービスにアクセスできる組織内のすべてのユーザーが利用できます。
データベースセレクター
クエリエディターの右上にあるドロップダウンメニューから、クエリするデータベースを選択します。 選択したデータベースがドロップダウンに表示されます。
設定
クエリエディター入力フィールドの上にある設定アイコンには、ダークテーマを有効/無効にするオプションや、オートコンプリートを無効/有効にするオプションが含まれています。
暗いテーマまたは明るいテーマを有効にするには、設定アイコン(
オートコンプリート
クエリエディターでは、クエリの記述時に、可能性のある SQL キーワードとテーブル名または列名の候補を自動的に表示します。 オートコンプリート機能はデフォルトで有効になっており、クエリエディターの設定で、いつでも無効または有効にすることができます。
オートコンプリートの設定はユーザーごとに行われ、そのユーザーが次にログインしたときも記憶されています。 この機能を無効にすると、いくつかのメタデータコマンドが処理されなくなり、クエリの編集時に作成者のスピードアップにつながるレコメンデーションが提案されます。
複数の順次クエリの実行
拡張クエリエディターを使用すると、複数のクエリを記述し、すべてのクエリを順番に実行できます。 複数のクエリを順番に実行すると、それぞれログエントリが生成されます。 ただし、クエリエディターコンソールには、最初のクエリの結果のみが表示されます。 実行されたクエリのトラブルシューティングや確認が必要な場合は、クエリログを確認します。 詳しくは、 クエリログドキュメントを参照してください。
選択したクエリの実行
複数のクエリを記述したが、実行する必要があるクエリが 1 つだけの場合は、選択したクエリをハイライト表示し、
選択したクエリを実行 アイコン このアイコンは、エディター内でクエリ構文を選択するまで、デフォルトで無効になっています。
クエリエディターセッションをキャンセル
長時間実行されるクエリをキャンセルすることで、クエリの実行を制御し、生産性を向上させます。 このアクションは、クエリの実行中にクエリエディターをクリアします。 クエリは引き続きバックグラウンドで実行されることに注意してください。 CTAS クエリの場合でも、出力データセットが生成されます。 エディターでの実行をキャンセルして SQL 文の作成を続行するには、クエリを実行した後で クエリをキャンセル を選択します。
確認ダイアログが表示されます。 「確認」を選択して、クエリの実行をキャンセルします。
結果数
クエリエディターの出力行は最大 50,000 行です。 クエリエディターコンソールに一度に表示する行数を選択できます。 コンソールに表示される行数を変更するには、「結果数」ドロップダウンを選択し、50、100、150、300、500、1000 の各オプションから選択します。
クエリの記述
クエリエディターは、クエリをできるだけ簡単に記述できるように構成されています。次のスクリーンショットは、UI でエディターがどのように表示されるかを示しています。ここでは、SQL 入力フィールドと「再生」がハイライト表示されています。
開発時間を最小限に抑えるために、返される行数に制限のあるクエリを開発することをお勧めします。 たとえば、SELECT fields FROM table WHERE conditions LIMIT number_of_rows
のように設定します。クエリが目的どおりの出力を生成することを確認したら、制限を解除して、CREATE TABLE tablename AS SELECT
と設定してクエリを実行し、データセットを生成します。
クエリエディターの記述ツール
クエリエディターの記述ツールを使用して、クエリオーサリングプロセスを強化します。 機能には、テキストの書式設定、SQL のコピー、クエリの詳細の管理、進行状況に応じた作業内容の保存またはスケジュール設定を行うオプションが含まれています。
テキストを書式設定
テキストを書式設定 機能は、標準化された構文スタイルを追加することで、クエリをわかりやすくします。 「テキストを書式設定」を選択して、クエリエディター内のすべてのテキストを標準化します。
SQL をコピー
コピーアイコンを選択して、クエリエディターからクリップボードに SQL をコピーします。 このコピー機能は、クエリテンプレートと、クエリエディターで新しく作成されたクエリの両方で使用できます。
クエリの詳細
クエリエディターでクエリを表示するには、「 テンプレート 」タブから保存済みのテンプレートを選択します。 クエリの詳細パネルには、選択したクエリを管理するための詳細情報とツールが表示されます。 また、クエリの最終変更日時や最終変更者(該当する場合)などの便利なメタデータも表示されます。
詳細パネルでは、UI から直接出力データセットを生成したり、表示されたクエリを削除または名前付けしたり、クエリ実行スケジュールを表示したり、クエリをスケジュールに追加したりできます。
出力データセットを生成するには、「CTAS として実行 を選択します。 出力データセットの詳細を入力 ダイアログが表示されます。 名前と説明を入力し、「CTAS として実行」を選択します。 新しいデータセットが データセット 「参照」タブに表示されます。 組織で使用可能なデータセットについて詳しくは、 データセットの表示に関するドキュメントを参照してください。
CTAS として実行 アクションを実行すると、確認メッセージがポップアップ表示され、アクションが成功したことが通知されます。 このポップアップメッセージには、クエリログワークスペースに移動するのに便利な方法を提供するリンクが含まれています。 クエリログについて詳しくは、 クエリログドキュメントを参照してください。
クエリの保存
クエリエディターには保存機能があり、クエリを保存して後で作業できます。 クエリを保存するには、クエリエディターの右上隅にある「保存 を選択します。 クエリを保存する前に、クエリの詳細 パネルを使用してクエリに名前を付ける必要があります。
クエリエディターでクエリを保存すると、確認メッセージがポップアップ表示され、アクションが成功したことが通知されます。 このポップアップメッセージには、クエリスケジュールワークスペースに移動する便利な方法を提供するリンクが含まれています。 カスタムケイデンスでクエリを実行する方法については、 クエリのスケジュール設定ドキュメントを参照してください。
スケジュール済みクエリ
テンプレートとして保存したクエリは、クエリエディターからスケジュールできます。 クエリをスケジュール設定すると、カスタムケイデンスでクエリの実行を自動化できます。 頻度、日時に基づいてクエリのスケジュールを設定したり、必要に応じて結果の出力データセットを選択したりできます。 クエリスケジュールは、UI から無効または削除することもできます。
スケジュールは、クエリエディターで設定します。 クエリエディターを使用する場合、既に作成および保存されたクエリにのみスケジュールを追加できます。 Query Service API にも同じ制限は適用されません。
UI でクエリスケジュールを作成する方法については、クエリスケジュールのドキュメントを参照してください。 また、API を使用してスケジュールを追加する方法について詳しくは、 スケジュールされたクエリのエンドポイントガイドを参照してください。
スケジュールされたクエリは、「 スケジュール済みクエリ タブのリストに追加されます。 そのワークスペースから、UI を使用して、スケジュールされたすべてのクエリジョブのステータスを監視できます。 「 スケジュール済みクエリ 」タブでは、クエリの実行に関する重要な情報を見つけたり、アラートを購読したりできます。 使用可能な情報には、ステータス、スケジュールの詳細、実行が失敗した場合のエラーメッセージ/コードが含まれます。 詳しくは、 スケジュール済みクエリドキュメントの監視を参照してください。
以前のクエリを検索する方法
クエリエディターで実行したクエリはすべて「ログ」テーブルに保存されます。「ログ」タブの検索機能を使用して、クエリの実行を検索できます。保存したクエリは「テンプレート」タブに表示されます。
クエリがスケジュールされている場合、「スケジュールされたクエリ」タブでは、UI を使用してこれらのクエリジョブをより明確に表示できます。 詳しくは、クエリ監視のドキュメントを参照してください。
オブジェクトブラウザー
オブジェクトブラウザーを使用すると、データセットを簡単に検索およびフィルタリングできます。 オブジェクトブラウザーを使用すると、多数のデータセットがある大規模な環境で、テーブルやデータセットの検索に費やす時間を短縮できます。 関連するデータとメタデータへの効率的なアクセスにより、クエリのオーサリングに集中でき、ナビゲーションに集中できなくなります。
オブジェクトブラウザーを使用してデータベース内を移動するには、検索フィールドにテーブル名を入力するか、「テーブル」を選択して使用可能なデータセットとテーブルのリストを展開します。 検索フィールドを使用すると、使用可能なテーブルのリストが、入力に基づいて動的にフィルタリングされます。
選択したデータベースに含まれているすべてのデータセットが、クエリエディターの左側のナビゲーションパネルに表示されます。
オブジェクトブラウザーに表示されるスキーマは、観察可能なスキーマです。 つまり、変更が直ちに表示されるので、これを使用して変更と更新をリアルタイムで監視できます。 観測可能なスキーマは、データの同期を確保するのに役立ち、デバッグや分析のタスクに役立ちます。
現在の制限事項
システムではクエリが順番に処理されます。つまり、一度に実行できるクエリは 1 つだけです。 クエリの進行中は、左側のナビゲーションから追加のテーブルにアクセスすることはできません。
テーブルメタデータへのアクセス
クイック検索に加えて、テーブル名の横にある「i」アイコンを選択することで、任意のテーブルのメタデータに簡単にアクセスできるようになりました。 これにより、選択したテーブルに関する詳細情報が提供され、クエリを記述する際に十分な情報に基づいた決定を行うのに役立ちます。
子テーブルの調査
子テーブルまたはリンクされたテーブルを検索するには、リスト内のテーブル名の横にあるドロップダウン矢印を選択します。 これにより、テーブルが展開され、関連する子テーブルが表示されます。また、データ構造が明確に表示され、より複雑なクエリ構成が可能になります。 フィールド名の横にあるアイコンは、列のデータタイプを示し、複雑なクエリ中に列のデータタイプを識別するのに役立ちます。
クエリエディターを使用してクエリを実行する
クエリエディターでクエリを実行するには、エディターに SQL を入力するか、「ログ」タブまたは「テンプレート」タブから以前のクエリを読み込み、「再生」を選択します。 クエリ実行のステータスは下の「コンソール」タブに表示され、出力データは「結果」タブに表示されます。
コンソール
コンソールには、クエリサービスのステータスと処理に関する情報が表示されます。コンソールには、クエリサービスへの接続ステータス、実行中のクエリ処理、およびこれらのクエリの実行時に発生したエラーメッセージが表示されます。
クエリの結果
クエリが完了すると、結果が「コンソール」タブの横の「結果」タブに表示されます。この表示には、クエリの表形式出力が表示され、選択した 結果数に応じて 50~1000 行の結果が表示されます。 このビューを使用すると、クエリが目的どおりの出力を生成することを確認できます。クエリでデータセットを生成するには、返される行の制限を解除し、CREATE TABLE tablename AS SELECT
と設定してクエリを実行します。クエリエディターでクエリの結果からデータセットを生成する方法については、データセットの生成についてのチュートリアルを参照してください。
クエリ結果のダウンロード
クエリが正常に実行されたら、結果を CSV、XLSX または JSON 形式でダウンロードし、オフライン分析、レポートまたはスプレッドシートのワークフローで使用します。 この機能により、オフラインでの分析、レポートおよび Excel ベースのプロセスのクエリ結果にすぐにアクセスできるようになるので、マーケティングチームや分析チームのワークフローが合理化されます。
クエリ結果をダウンロードするには、クエリエディター 結果 タブの右上隅にある「ダウンロード」を選択します。 次に、ドロップダウンメニューから CSV、XLSX または JSON を選択します。 ファイルがローカルマシンに自動的にダウンロードされます。 ユースケースに合った形式、軽量エクスポートの場合は CSV、フォーマットされたスプレッドシートの場合は XLSX、構造化データ処理の場合は JSON を選択します。
「データが失われる可能性があります。 このブックをコンマ区切り(.csv)形式で保存すると、一部の機能が失われることがあります。 これらの機能を保持するには、Excel ファイル形式で保存します。」
また、日付と時刻の形式は、ファイルタイプによって異なる場合があることに注意してください。 CSV ファイルはクエリ結果に表示される形式を保持しますが、XLSX ファイルは Excel で自動的にローカライズされた形式を適用できます。 この警告が表示された場合は、続行しても問題ありません。 Excel 固有の書式を保持するには、代わりにファイルを XLSX として保存します。
結果を全画面で表示
クエリが正常に実行されたら、「結果」タブの 結果を表示 を選択して、結果を表形式でフルスクリーン表示で開きます。
フルスクリーンプレビューを使用すると、幅の広いテーブルを簡単にスキャンし、水平スクロールせずに行レベルの詳細を調べることができます。 フルスクリーン表示では、出力がサイズ変更可能なグリッドで表示されるので、大きなデータセットの確認や、列をまたいだスキャンが容易になります。
結果をコピー
クエリエディターの拡張コピー機能を使用すると、クエリ結果をコンマ区切り値(CSV)でコピーして Excel などのスプレッドシートツールに貼り付け、即座に検証またはレポートを作成できます。 この機能により、サードパーティのツールを使用しなくても、読みやすさが向上し、書式設定が保持され、ワークフローが効率化されます。
「 結果 」タブまたは結果のフルスクリーンのプレビューから、クエリ結果をコピーできます。 「結果」タブで、コピーアイコン(
または、「結果を表示」を選択して、フルスクリーンプレビューを開きます。 このダイアログから、個々の行を選択するか、左上隅のチェックボックスを使用してすべての行を選択してから、コピーアイコン(
従来の結果テーブル(限定提供)
従来のバージョンのクエリエディターは、QA やスプレッドシートベースのレビューなど、柔軟な手動のデータワークフローに依存するユーザーを対象としています。
ネイティブのブラウザーベースのドラッグ選択がサポートされるので、標準の選択動作を使用して、出力の任意の部分(個々のセルやブロックを含む)をハイライトしてコピーできます。 これは、構造化行の選択と専用のコピーアクションを使用する拡張テーブルとは対照的です。
コピーされたデータはタブで区切られているので、Excel などのツールに貼り付けた際に、列の位置が固定され、読み取り可能な状態になります。 列ヘッダーは、ヘッダー行全体をドラッグ&選択する際にも含まれます。
例
クエリサービスは、業界やビジネスシナリオをまたいだ様々なユースケースに対するソリューションを提供します。 これらの例は、サービスが多様なニーズに対応する上での柔軟性と影響を示しています。 クエリサービスが特定のビジネスニーズにどのように価値をもたらすことができるかを明らかにするには、ユースケースに関するドキュメントの包括的なコレクションを参照してください。 クエリサービスを使用して、運用効率とビジネス成功を強化するためのインサイトとソリューションを提供する方法を説明します。
クエリサービスを使用したクエリの実行のチュートリアルビデオ
次のビデオでは、Adobe Experience Platform インターフェイスおよび PSQL クライアントでクエリを実行する方法を説明します。 また、このビデオでは、XDM オブジェクト内での個々のプロパティの使用、Adobe定義関数、CREATE TABLE AS SELECT (CTAS)クエリの使用方法についても説明します。
次の手順
クエリエディターで使用できる機能とアプリケーションの操作方法について説明しました。これで、独自のクエリを Experience Platform で直接記述できます。 Data Lake のデータセットに対して SQL クエリを実行する方法については、クエリの実行に関するガイドを参照してください。