スキルOfficialdatabase

📦collection

プラグイン: zilliz
ソース: GitHub で見る ↗

説明

次のような場合に使用: ユーザーがMilvusにおけるコレクションおよびコレクションエイリアスの作成、一覧表示、詳細確認、削除、名前変更、ロード、解放、または管理を行いたいとき。

原文を表示

Use when the user wants to create, list, describe, drop, rename, load, release, or manage collections and collection aliases in Milvus.

ユースケース

✓Milvusのコレクション作成・管理を行うとき
✓コレクションエイリアスの作成・削除を行うとき
✓コレクションの一覧表示・詳細確認をするとき
✓コレクションのロード・解放を行うとき
✓コレクション名を変更するとき

本文（日本語訳）

前提条件

CLIがインストール済みで、ログイン済みかつクラスターコンテキストが設定されていること（セットアップスキルを参照）。

コマンドリファレンス

すべてのコレクションコマンドは、デフォルト以外のデータベースを対象とするためにオプションの --database <db-name> フラグを受け付けます。省略した場合は、現在のコンテキストのデータベースが使用されます。

コレクションメトリクス

collectionName をリクエストボディに設定して POST /v2/clusters/{clusterId}/metrics/query に対し、コレクション単位のメトリクスをクエリします。 Webコンソールの「Collection Detail > Metrics」ページに相当します。

zilliz collection metrics --collection-name <collection-name> --metric <metric-name>
# オプション:
#   --cluster-id <cluster-id>         クラスターコンテキストを上書き
#   --period <duration>               例: 1h, 24h, 7d（--start/--end と排他）
#   --start <iso-8601> --end <iso-8601>
#   --granularity <duration> / -g     例: 30s, 5m, 1h（省略時は自動選択）
#   -o table                          デフォルトのインラインチャートの代わりにピボットテーブルを表示

デフォルトの出力はインラインテキストチャートです。メトリクスごとに1ブロックが生成され、サマリー行（min / max / avg / last）と点字レンダリングの折れ線グラフが表示されます。点字フォントのサポートが不十分なターミナルでは、-o table（または --output table）を明示的に指定することでピボットテーブルレイアウトに切り替えられます。 -o json、-o yaml、-o csv、および --query は常に両方のレンダラーをバイパスし、生のレスポンスを返します。

実行例:

# 期間の省略記法: コレクションの直近1時間の SEARCH_QPS
zilliz collection metrics -c my_coll -m SEARCH_QPS --period 1h

# 1h粒度で明示的な範囲を指定
zilliz collection metrics -c my_coll -m ENTITIES_LOADED \
  --start 2026-04-13T00:00:00Z --end 2026-04-14T00:00:00Z -g 1h

# 1回のコールで複数メトリクスを指定
zilliz collection metrics -c my_coll -m SEARCH_QPS -m SEARCH_LATENCY_P99 --period 6h

メトリクスのスコープ

各メトリクスにはスコープが付与されています。 zilliz collection metrics が受け付けるのは、スコープが Collection または Both のメトリクスのみです。 Clusterスコープ専用のメトリクスを指定した場合は、以下のエラーが出力されます:

Metric '<NAME>' is cluster-scope only and cannot be used with --collection-name.

スコープ	メトリクス
Clusterのみ（ここでは拒否）	`CU_COMPUTATION`, `CU_CAPACITY`, `CU_SIZE`, `REPLICA_COUNT`, `STORAGE`, `COLLECTIONS`, `SLOW_QUERIES`, `READ_VCU`, `WRITE_VCU`
Collection / Both（使用可）	`SEARCH_QPS`, `QUERY_QPS`, `INSERT_QPS`, `UPSERT_QPS`, `DELETE_QPS`, `BULK_INSERT_QPS`, `SEARCH_LATENCY_AVG/P99`, `QUERY_LATENCY_AVG/P99`, `INSERT_LATENCY_AVG/P99`, `UPSERT_LATENCY_AVG/P99`, `DELETE_LATENCY_AVG/P99`, VPSカウンター, 失敗率カウンター, `ENTITIES`, `ENTITIES_LOADED`, `ENTITIES_INDEXED`, および下記のハイブリッド検索エイリアス

ハイブリッド検索エイリアス

CLI名	バックエンド名
`HYBRID_SEARCH_QPS`	`REQ_HYBRID_SEARCH_COUNT`
`HYBRID_SEARCH_LATENCY_AVG`	`REQ_HYBRID_SEARCH_LATENCY_AVG`
`HYBRID_SEARCH_LATENCY_P99`	`REQ_HYBRID_SEARCH_LATENCY_P99`
`HYBRID_SEARCH_FAIL_RATE`	`REQ_FAIL_RATE_HYBRID_SEARCH`

クラスター全体のメトリクス（CUサイジング、ストレージ、サーバーレスVCU、スロークエリ）には、代わりに zilliz cluster metrics を使用してください。詳細はモニタリングスキルを参照してください。

コレクションの作成

zilliz collection create --name <collection-name> --dimension <vector-dimension>
# オプション:
#   --metric-type <COSINE|L2|IP>
#   --id-type <Int64|VarChar>
#   --auto-id <true|false>
#   --primary-field <primary-key-field-name>
#   --vector-field <vector-field-name>
#   --database <database-name>
# または生JSONで指定: --body '{"schema": {"fields": [{"fieldName": "id", "dataType": "Int64", "isPrimary": true}, {"fieldName": "vector", "dataType": "FloatVector", "elementTypeParams": {"dim": "768"}}]}}'

コレクションの一覧表示

zilliz collection list
# オプション: --database <database-name>

コレクションの詳細確認

zilliz collection describe --name <collection-name>
# オプション: --database <database-name>

コレクションの削除

zilliz collection drop --name <collection-name-to-drop>
# オプション: --database <database-name>

コレクションのリネーム

zilliz collection rename --name <current-collection-name> --new-name <new-collection-name>
# オプション: --database <current-database-name>, --new-database <target-database-name>

コレクションのロード

zilliz collection load --name <collection-name>
# オプション: --database <database-name>

コレクションのリリース

zilliz collection release --name <collection-name>
# オプション: --database <database-name>

ロード状態の取得

zilliz collection get-load-state --name <collection-name>
# オプション: --database <database-name>

統計情報の取得

zilliz collection get-stats --name <collection-name>
# オプション: --database <database-name>

コレクションの存在確認

zilliz collection has --name <collection-name>
# オプション: --database <database-name>

コレクションのフラッシュ

zilliz collection flush --name <collection-name>
# オプション: --database <database-name>

コレクションのコンパクション

zilliz collection compact --name <collection-name>
# オプション: --database <database-name>

コレクションエイリアス

エイリアスの作成

zilliz alias create --collection <target-collection-name> --alias <alias-name>
# オプション: --database <database-name>

エイリアスの一覧表示

zilliz alias list --database <database-name>
# オプション: --collection <filter-by-collection-name>

エイリアスの詳細確認

zilliz alias describe --alias <alias-name>
# オプション: --database <database-name>

エイリアスの変更

zilliz alias alter --collection <new-target-collection> --alias <alias-name-to-reassign>
# オプション: --database <database-name>

エイリアスの削除

zilliz alias drop --alias <alias-name-to-drop>
# オプション: --database <database-name>

ガイダンス

ユーザーがコレクションを作成したい場合は、適切なdimension・メトリクスタイプ・スキーマを提案するために、ユースケースを確認してください。
コレクションを削除する前には、必ずユーザーに確認を取ってください。この操作はすべてのデータを削除します。
コレクションは、検索またはクエリを実行する前にロードされている必要があります。
コレクションを作成した後、ユーザーがすぐにクエリを実行する予定がある場合は、ロードを提案してください。
ベクター操作を行う前に、describe コマンドでスキーマを確認してください。

原文（English）を表示

Prerequisites

CLI installed, logged in, and cluster context set (see setup skill).

Commands Reference

All collection commands accept an optional --database <db-name> flag to target a non-default database. If omitted, the database from the current context is used.

Collection metrics

Query per-collection metrics against POST /v2/clusters/{clusterId}/metrics/query with collectionName set in the request body. Mirrors the web console's Collection Detail > Metrics page.

zilliz collection metrics --collection-name <collection-name> --metric <metric-name>
# Optional:
#   --cluster-id <cluster-id>         Override cluster context
#   --period <duration>               e.g. 1h, 24h, 7d (mutually exclusive with --start/--end)
#   --start <iso-8601> --end <iso-8601>
#   --granularity <duration> / -g     e.g. 30s, 5m, 1h (auto-selected if omitted)
#   -o table                          Render pivot table instead of the default inline chart

The default output is an inline text chart: one block per metric with a summary line (min / max / avg / last) and a Braille-rendered line chart. Pass an explicit -o table (or --output table) to render the pivot-table layout — useful for terminals without good Braille font support. -o json, -o yaml, -o csv, and --query always bypass both renderers and return the raw response.

Examples:

# Period shorthand: last hour of SEARCH_QPS for a collection
zilliz collection metrics -c my_coll -m SEARCH_QPS --period 1h

# Explicit range with 1h granularity
zilliz collection metrics -c my_coll -m ENTITIES_LOADED \
  --start 2026-04-13T00:00:00Z --end 2026-04-14T00:00:00Z -g 1h

# Multiple metrics in a single call
zilliz collection metrics -c my_coll -m SEARCH_QPS -m SEARCH_LATENCY_P99 --period 6h

Metric scope

Each metric is tagged with a scope. zilliz collection metrics only accepts metrics whose scope is Collection or Both. Using a Cluster-only metric emits:

Metric '<NAME>' is cluster-scope only and cannot be used with --collection-name.

Scope	Metrics
Cluster only (rejected here)	`CU_COMPUTATION`, `CU_CAPACITY`, `CU_SIZE`, `REPLICA_COUNT`, `STORAGE`, `COLLECTIONS`, `SLOW_QUERIES`, `READ_VCU`, `WRITE_VCU`
Collection / Both (allowed)	`SEARCH_QPS`, `QUERY_QPS`, `INSERT_QPS`, `UPSERT_QPS`, `DELETE_QPS`, `BULK_INSERT_QPS`, `SEARCH_LATENCY_AVG/P99`, `QUERY_LATENCY_AVG/P99`, `INSERT_LATENCY_AVG/P99`, `UPSERT_LATENCY_AVG/P99`, `DELETE_LATENCY_AVG/P99`, VPS counters, failure-rate counters, `ENTITIES`, `ENTITIES_LOADED`, `ENTITIES_INDEXED`, plus the hybrid-search aliases below

Hybrid-search aliases

CLI name	Backend name
`HYBRID_SEARCH_QPS`	`REQ_HYBRID_SEARCH_COUNT`
`HYBRID_SEARCH_LATENCY_AVG`	`REQ_HYBRID_SEARCH_LATENCY_AVG`
`HYBRID_SEARCH_LATENCY_P99`	`REQ_HYBRID_SEARCH_LATENCY_P99`
`HYBRID_SEARCH_FAIL_RATE`	`REQ_FAIL_RATE_HYBRID_SEARCH`

For cluster-wide metrics (CU sizing, storage, serverless VCU, slow queries) use zilliz cluster metrics instead -- see the monitoring skill.

Create a Collection

zilliz collection create --name <collection-name> --dimension <vector-dimension>
# Optional:
#   --metric-type <COSINE|L2|IP>
#   --id-type <Int64|VarChar>
#   --auto-id <true|false>
#   --primary-field <primary-key-field-name>
#   --vector-field <vector-field-name>
#   --database <database-name>
# Or use raw JSON: --body '{"schema": {"fields": [{"fieldName": "id", "dataType": "Int64", "isPrimary": true}, {"fieldName": "vector", "dataType": "FloatVector", "elementTypeParams": {"dim": "768"}}]}}'

List Collections

zilliz collection list
# Optional: --database <database-name>

Describe a Collection

zilliz collection describe --name <collection-name>
# Optional: --database <database-name>

Drop a Collection

zilliz collection drop --name <collection-name-to-drop>
# Optional: --database <database-name>

Rename a Collection

zilliz collection rename --name <current-collection-name> --new-name <new-collection-name>
# Optional: --database <current-database-name>, --new-database <target-database-name>

Load a Collection

zilliz collection load --name <collection-name>
# Optional: --database <database-name>

Release a Collection

zilliz collection release --name <collection-name>
# Optional: --database <database-name>

Get Load State

zilliz collection get-load-state --name <collection-name>
# Optional: --database <database-name>

Get Statistics

zilliz collection get-stats --name <collection-name>
# Optional: --database <database-name>

Check if a Collection Exists

zilliz collection has --name <collection-name>
# Optional: --database <database-name>

Flush a Collection

zilliz collection flush --name <collection-name>
# Optional: --database <database-name>

Compact a Collection

zilliz collection compact --name <collection-name>
# Optional: --database <database-name>

Collection Aliases

Create an Alias

zilliz alias create --collection <target-collection-name> --alias <alias-name>
# Optional: --database <database-name>

List Aliases

zilliz alias list --database <database-name>
# Optional: --collection <filter-by-collection-name>

Describe an Alias

zilliz alias describe --alias <alias-name>
# Optional: --database <database-name>

Alter an Alias

zilliz alias alter --collection <new-target-collection> --alias <alias-name-to-reassign>
# Optional: --database <database-name>

Drop an Alias

zilliz alias drop --alias <alias-name-to-drop>
# Optional: --database <database-name>

Guidance

When the user wants to create a collection, ask about their use case to recommend appropriate dimension, metric type, and schema.
Before dropping a collection, always confirm with the user -- this deletes all data.
A collection must be loaded before it can be searched or queried.
After creating a collection, suggest loading it if the user plans to query immediately.
Use describe to inspect schema before performing vector operations.

原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。