このドキュメントでは、Dataplex 検索クエリの構文について説明します。このドキュメントを読む前に、データエントリ、アスペクト、アスペクト タイプ、エントリ グループ、エントリタイプなどの Dataplex Catalog のコンセプトを理解しておくことが重要です。詳細については、Dataplex Catalog の概要をご覧ください。
Google Cloud コンソールで Dataplex Catalog の検索クエリを起動するには、Dataplex の [検索] ページに移動し、検索モードとして [Dataplex Catalog] を選択します。
詳細については、Dataplex Catalog でリソースを検索するをご覧ください。
シンプルな検索機能
最も簡単な形式の Dataplex Catalog 検索クエリは、単一の述語で構成されます。そのような述語は、複数のメタデータに一致する可能性があります。
- リソースの名前、表示名、または説明の部分文字列
- リソースのタイプのサブ文字列
- リソースのスキーマにおける列名（またはネストされた列名）の部分文字列
- プロジェクト ID の部分文字列
- 概要の説明の文字列
たとえば、述語 foo は次のエンティティと一致します。
foo.barという名前のリソース- 表示名が
Foo Barのリソース - 説明が
This is the foo scriptのリソース - 正確に
fooタイプのリソース - リソースのスキーマの列
foo_bar - リソースのスキーマのネストされた列
foo_bar - プロジェクト
prod-foo-bar - 概要に
fooという単語が含まれるリソース
修飾された述語
述語の先頭にキーを付けて修飾すると、照合範囲を特定のメタデータ部分に限定できます。
- 等号（
=）は、検索の対象を完全一致に絞り込むものです。 - キーの後のコロン（
:）は、述語を検索結果内の値に含まれる部分文字列またはトークンと照合します。
トークン化により、テキストのストリームが一連のトークン（各トークンは通常 1 つの単語に対応）に分割されます。
次に例を示します。
name:fooは、foo部分文字列（foo1とbarfoo）を含む名前のエンティティを選択します。description:fooは、説明にfooトークン（barやfooなど）を含むエンティティを選択します。location=fooは、ロケーション名がfooの指定されたロケーションのリソースに一致します。
述語キー type、system、location、orgid は、部分文字列修飾子（:）ではなく、完全一致修飾子（=）のみをサポートします（例: type=foo、orgid=number）。
Dataplex Catalog は、次の修飾子をサポートしています。
| 修飾子 | 説明 |
|---|---|
name:x |
x をリソース ID の部分文字列として照合します。 |
displayname:x |
x をリソースの表示名の部分文字列と照合します。 |
column:x |
x をリソースのスキーマの列名（またはネストされた列名）の部分文字列と照合します。 |
description:x |
x をリソースの説明のトークンと照合します。 |
label:bar |
ラベル（ある値を持つ）を持つ BigQuery リソースを照合します。ラベルキーには部分文字列として bar があります。 |
label=bar |
ラベル（値があるもの）を持ち、ラベルキーが文字列として bar と等しい BigQuery リソースと一致します。 |
label:bar:x |
x を、BigQuery リソースに添付されたキー bar を含むラベルの値の部分文字列と照合します。 |
label=foo:bar |
キーが foo でキー値が bar である BigQuery リソースと照合します。 |
label.foo=bar |
キーが foo でキー値が bar である BigQuery リソースと照合します。 |
label.foo |
ラベルを持ち、ラベルキーが文字列として foo と等しい BigQuery リソースと一致します。 |
type=TYPE |
特定のエントリタイプまたはその型エイリアスのリソースを照合します。 |
projectid:bar |
bar と ID の部分文字列が一致する Google Cloud プロジェクト内のリソースを照合します。 |
parent:x |
x をリソースの階層パスの文字列部分と照合します。親パスは、親リソースの fully_qualified_name です。 |
orgid=number |
Google Cloud 組織内のリソースを number の正確な ID 値と照合します。 |
system=SYSTEM |
指定されたシステムのリソースを照合します。 |
location=LOCATION |
指定されたロケーションのリソースを正確な名前と照合します。たとえば、 BigQuery Omni アセットは、BigQuery Omni のロケーション名を使用してこの修飾子をサポートしています。たとえば、 |
createtime |
指定した日時以前または以降に作成されたリソースを検索します。 次に例を示します。
タイムスタンプ形式: すべてのタイムスタンプは GMT にする必要があります（タイムゾーンはサポートされていません）。部分的なタイムスタンプ、ハイフン（ 次に例を示します。
|
updatetime |
指定した日時以前または以降に更新されたリソースを検索します。 次に例を示します。
タイムスタンプ形式: すべてのタイムスタンプは GMT にする必要があります（タイムゾーンはサポートされていません）。部分的なタイムスタンプ、ハイフン（ 次に例を示します。
|
fully_qualified_name:x |
x を fully_qualified_name の部分文字列として照合します。 |
fully_qualified_name=x |
x を fully_qualified_name として照合します。 |
アスペクト検索
アスペクトの付加に基づいてエントリを検索するには、次のクエリ構文を使用します。
| 修飾子 | 説明 |
|---|---|
aspect:x |
x を、エントリにアタッチされているアスペクトのアスペクト タイプの完全パスの文字列部分と照合します（projectid.location.ASPECT_TYPE_ID 形式）。 |
aspect=x |
エントリにアタッチされているアスペクトのアスペクト タイプの完全パスとして x と一致します（projectid.location.ASPECT_TYPE_ID 形式）。 |
aspect:xOPERATORvalue |
アスペクト フィールドの値を検索します。 サポートされる演算子のリストは、次のようにアスペクト内のフィールドのタイプによって異なります。
検索できるのは、アスペクトの最上位フィールドのみです。 たとえば、次のクエリはすべて、
|
論理演算子
クエリは、論理演算子を使用して複数の述語で構成できます。演算子を指定しないと、論理 AND が使用されます。たとえば、foo bar は、述語 foo と述語 bar の両方に一致するエンティティを返します。
論理 AND と論理 OR がサポートされています。例: foo OR bar
-（ハイフン）または NOT 接頭辞を付けると、述語を否定できます。たとえば、-name:foo は、述語 foo と一致しない名前を持つエンティティを返します。
論理演算子では大文字と小文字が区別されません。たとえば、or と OR はどちらも許容されるものです。
簡略構文
簡略化された検索構文も使用できます。OR 演算子には |（縦棒）を、AND 演算子には ,（カンマ）を使用します。
たとえば、OR 演算子を使用して、複数のプロジェクトの 1 つのエントリを検索するには、次の簡略化された構文を使用します。
projectid:(id1|id2|id3|id4)
省略形の構文を使用しない同じ検索は次のようになります。
projectid:id1 OR projectid:id2 OR projectid:id3 OR projectid:id4
列名が一致するエントリを検索するには、次のようにします。
- 論理積:
column:(name1, name2, name3) - 論理和:
column:(name1|name2|name3)
この簡略構文は、label を除く修飾された述語で使用できます。
次のステップ
- Dataplex Catalog でリソースを検索する方法を確認する。
- Dataplex Catalog の詳細を確認する。
- アスペクトを使用してエントリをメタデータで拡充する方法を確認する。
- エントリを管理してカスタムソースを取り込む方法を確認する。