knowledge-catalog-discovery について
knowledge-catalog-discovery は、データカタログのエントリー検索や、アセットのメタデータと関連情報の取得に使う Node.js スキルです。エントリーやアスペクトタイプを検索し、指定したリソースを参照できます。
主な機能
- 01条件を指定したカタログ検索
- 02アセットのメタデータと関連情報の取得
- 03個別カタログエントリーの参照
- 04関連するアスペクトタイプの検索
活用シーン
- 01テーブル、データセット、ビューの検索
- 02データアセット間の関連性の確認
- 03指定したエントリーのアスペクト取得
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ cline/ skills --skill knowledge-catalog-discoveryインストール後、Claude Code で/knowledge-catalog-discoveryを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
scripts/lookup_context.jslookup_entry.jssearch_aspect_types.jssearch_entries.js詳細
使用方法
すべてのスクリプトは Node.js を使用して実行できます。<param_name> と <param_value> を実際の値に置き換えてください。
Bash:
node <skill_dir>/scripts/<script_name>.js '{"<param_name>": "<param_value>"}'
PowerShell:
node <skill_dir>/scripts/<script_name>.js '{\"<param_name>\": \"<param_value>\"}'
注:スクリプトは複数の .env ファイルから環境変数を自動的に読み込みます。環境変数がないためにスキルの実行に失敗した場合を除き、ユーザーに変数の設定を求めないでください。
スクリプト
lookup_context
1 つ以上のデータアセットに関する詳細なメタデータと、それらの関連情報を取得します。
パラメーター
| 名前 | 型 | 説明 | 必須 | デフォルト |
|---|---|---|---|---|
| resources | array | 必須。最大 10 個のリソース名のリストです。リソースは異なるプロジェクトに属していてもかまいませんが、すべて同じロケーションに属している必要があります。 | はい |
lookup_entry
Catalog からデータアセット(例:テーブル/データセット/ビュー)の特定のメタデータを取得します。
パラメーター
| 名前 | 型 | 説明 | 必須 | デフォルト |
|---|---|---|---|---|
| entry | string | 必須。次の形式の Entry のリソース名です:projects/{project}/locations/{location}/entryGroups/{entryGroup}/entries/{entry}。 | はい | |
| view | integer |
## 引数:view
**型:** Integer
**説明:** 任意。返すエントリとそのアスペクトの部分を指定します。
**指定可能な値:**
* 1(BASIC):アスペクトを含めずにエントリを返します。
* 2(FULL):すべての必須アスペクトと、必須ではないアスペクトのキーを返します。(デフォルト)
* 3(CUSTOM):aspect_types フィールドで指定されたエントリとアスペクトを返します(最大 100 個のアスペクト)。aspect_types が空でない場合は、必ずこのビューを使用してください。
* 4(ALL):エントリと、必須および任意のアスペクトの両方を返します(最大 100 個のアスペクト)。
| いいえ | `2` |
| aspectTypes | array | 任意。指定されたアスペクトタイプに返されるアスペクトを限定します。CUSTOM ビューと組み合わせて使用した場合にのみ機能します。 | いいえ | [] |
search_aspect_types
クエリに関連するアスペクトタイプを検索します。
パラメーター
| 名前 | 型 | 説明 | 必須 | デフォルト |
|---|---|---|---|---|
| query | string | アスペクトタイプを照合する検索クエリです。 | はい | |
| pageSize | integer | 検索ページで返されるアスペクトタイプの数です。 | いいえ | 5 |
| orderBy | string | 結果の並び順を指定します。サポートされている値は、relevance、last_modified_timestamp、last_modified_timestamp asc です。 | いいえ | relevance |
search_entries
指定された検索クエリに基づいて、Catalog 内のデータアセット(例:テーブル/データセット/ビュー)を検索します。
パラメーター
| 名前 | 型 | 説明 | 必須 | デフォルト |
|---|---|---|---|---|
| query | string | エントリを検索するクエリ文字列です。Dataplex の検索構文に従います。論理演算子(AND、OR、NOT)とグループ化をサポートしています。たとえば、名前が変更された可能性のあるテーブルを見つけるには、'type:table (name:books OR fiction)' を使用できます。複数回に分けて個別に呼び出すよりも効率的な場合があります。警告:特定のフィルター(例:type:table)を指定しない広範な検索は、時間がかかり、多くのリソースを消費する可能性があります。探索的な検索を行う場合は、必ず pageSize パラメーターを使用して、返される結果の数を制限してください。 | はい | |
| scope | string | 検索範囲を特定のプロジェクトまたは組織に限定します。形式は organizations/<org_id>、projects/<project_id>、または projects/<project_number> である必要があります。 | いいえ | `` |
| pageSize | integer | 検索ページで返される結果の数です。 | いいえ | 5 |
| orderBy | string | 結果の並び順を指定します。サポートされている値は、relevance、last_modified_timestamp、last_modified_timestamp asc です。 | いいえ | relevance |