Milvus_CLI コマンドリファレンス

Milvusコマンドラインインタフェース(CLI)はデータベース接続、データ操作、データのインポート/エクスポートをサポートするコマンドラインツールです。

このトピックでは、サポートされているすべてのコマンドと対応するオプションを紹介します。また、参考のためにいくつかの例も含まれています。

クリア

画面をクリアします。

構文

clear

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

接続

Milvusに接続する。

構文

connect [-uri (text)] [-t (text)]

オプション

オプション	フルネーム	説明
-uri	-uri	(オプション) uri名。デフォルトは "http://127.0.0.1:19530"。
-t	-トークン	(オプション) zillizクラウドのapikeyまたはusername:password 。デフォルトはNoneです。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

milvus_cli > connect -uri http://127.0.0.1:19530 

データベースの作成

Milvusでデータベースを作成する。

構文

create database -db (text) 

オプション

オプション	フルネーム	説明
-db	-データベース	[必須] milvusでのデータベース名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

例

次の例では、milvusにデータベースtestdb を作成しています。

milvus_cli > create database -db testdb

データベース使用

milvusでデータベースを使用する。

構文

use database -db (text) 

オプション

オプション	フルネーム	説明
-db	-データベース	[必須] milvusでのデータベース名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

例

以下の例では、milvusのデータベースtestdb 。

milvus_cli > use database -db testdb

リスト データベース

milvusのデータベースをリストアップする。

構文

list databases 

例

例 1

次の例はmilvusのデータベースをリストアップします。

milvus_cli > list databases

データベース削除

milvusのデータベースを削除する。

構文

delete database -db (text) 

オプション

オプション	フルネーム	説明
-db	-データベース	[必須] milvusでのデータベース名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

例

次の例では、milvusのデータベースtestdb を削除しています。

milvus_cli > delete database -db testdb

ユーザ作成

milvusにユーザを作成する。

構文

create user -u (text) -p (text)

オプション

オプション	フルネーム	説明
-p	-パスワード	milvusのユーザーパスワード。デフォルトは "None"。
-u	-ユーザー名	milvusでのユーザー名。デフォルトは "None" です。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

例

次の例では、milvusにユーザーzilliz 、パスワードzilliz を作成します。

milvus_cli > create user -u zilliz -p zilliz

エイリアスの作成

コレクションに一意のエイリアスを指定します。

構文

create alias -c (text) -a (text) [-A] 

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-a	-エイリアス名	別名。
-A	-alter	(オプション) 別名を指定したコレクションに転送するフラグ。
-help	n/a	コマンドの使用に関するヘルプを表示します。

例

例 1

次の例は、car コレクションのcarAlias1 とcarAlias2 エイリアスを作成します。

milvus_cli > create alias -c car -a carAlias1

例 2

次の例は、carAlias1 エイリアスをcar コレクションからcar2 コレクションに転送します。

milvus_cli > create alias -c car2 -A -a carAlias1

コレクションの作成

コレクションを作成する。

構文

create collection -c (text) -f (text) -p (text) [-a] [-d (text)]

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-f	-スキーマ・フィールド	(複数可）<fieldName>:<dataType>:<dimOfVector/desc> 形式のフィールド・スキーマ。
-p	-schema-primary-field	主キー・フィールドの名前。
-a	-schema-auto-id	(オプション）IDを自動的に生成するフラグ。
-desc	-schema-description	(オプション) コレクションの説明。
-level	-consistency-level	(オプション) 整合性レベル：Bounded、Session、Strong、Eventual。
-d	-is-dynamic	(オプション) コレクション・スキーマがダイナミック・フィールドをサポートするかどうか。
-s	-shards-num	(オプション) シャード番号
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

## For array field: --schema-field support <fieldName>:<dataType>:<maxCapacity>:<elementDataType>(:<maxLength>if Varchar)

milvus_cli > create collection -c car -f id:INT64:primary_field -f vector:FLOAT_VECTOR:128 -f color:INT64:color -f brand:ARRAY:64:VARCHAR:128 -p id -A -d 'car_collection'

パーティション作成

パーティションを作成します。

構文

create partition -c (text) -p (text) [-d (text)]

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-p	-パーティション	パーティション名。
-d	-パーティション名。	(オプション）パーティションの説明。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

例

milvus_cli > create partition -c car -p new_partition -d test_add_partition

インデックスの作成

フィールドのインデックスを作成します。

構文

create index

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

フィールドのインデックスを作成し、必要な入力を求めるプロンプトを表示する：

milvus_cli > create index

Collection name (car, car2): car2

The name of the field to create an index for (vector): vector

Index name: vectorIndex

# Default is ''
Index type FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, RNSG, HNSW, ANNOY, AUTOINDEX, DISKANN, GPU_IVF_FLAT, GPU_IVF_PQ, SPARSE_INVERTED_INDEX, SPARSE_WAND, SCANN, STL_SORT, Trie, INVERTED, ) []: IVF_FLAT  

# Default is ''
Index metric type (L2, IP, HAMMING, TANIMOTO, COSINE, ) []: 

Timeout []:

delete user

ユーザを削除します。

構文

delete user -u (text)

オプション

オプション	フルネーム	説明
-u	-ユーザー名	ユーザー名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

milvus_cli > delete user -u zilliz

エイリアス削除

エイリアスを削除します。

構文

delete alias -a (text) 

オプション

オプション	フルネーム	説明
-a	-エイリアス名	別名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

コレクション削除

コレクションを削除します。

構文

delete collection -c (text) 

オプション

オプション	フルネーム	説明
-c	-コレクション名	削除するコレクションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

milvus_cli > delete collection -c car

エンティティを削除する

エンティティを削除する。

構文

delete entities -c (text) -p (text) 

オプション

オプション	フルネーム	説明
-c	-コレクション名	削除するエンティティが属するコレクションの名前。
-p	-パーティション	(オプション）削除するパーティション名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

例

milvus_cli > delete entities -c car

The expression to specify entities to be deleted, such as "film_id in [ 0, 1 ]": film_id in [ 0, 1 ]

You are trying to delete the entities of collection. This action cannot be undone!

Do you want to continue? [y/N]: y

パーティション削除

パーティションを削除します。

構文

delete partition -c (text) -p (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	削除するパーティションが属するコレクションの名前。
-p	-パーティション	削除するパーティション名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

例

milvus_cli > delete partition -c car -p new_partition

インデックスの削除

インデックスと対応するインデックスファイルを削除します。

構文

delete index -c (text) -in (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-in	-インデックス名	インデックス名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

例

milvus_cli > delete index -c car -in indexName

ショーコレクション

コレクションの詳細情報を表示します。

構文

show collection -c (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

milvus_cli > show collection -c test_collection_insert

show partition

パーティションの詳細情報を表示します。

構文

show partition -c (text) -p (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	パーティションが属するコレクションの名前。
-p	-パーティション	パーティションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

例

milvus_cli > show partition -c test_collection_insert -p _default

ショー・インデックス

インデックスの詳細情報を表示します。

構文

show index -c (text) -in (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-in	-インデックス名	インデックスの名前。

| --help | n/a | コマンドの使用に関するヘルプを表示します。|

例

milvus_cli > show index -c test_collection -in index_name

終了

コマンドラインウィンドウを閉じます。

構文

exit

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

ヘルプ

コマンドの使用に関するヘルプを表示します。

構文

help <command>

コマンド

コマンド	説明
クリア	画面を消去します。
接続	Milvusに接続します。
作成	コレクション、データベース、パーティション、ユーザ、インデックスを作成する。
削除	コレクション、データベース、パーティション、エイリアス、ユーザ、インデックスを削除します。
終了	コマンドラインウィンドウを閉じます。
ヘルプ	コマンドの使用に関するヘルプを表示します。
インサート	パーティションにデータをインポートします。
リスト	コレクション、データベース、パーティション、ユーザ、インデックスをリストします。
ロード	コレクションやパーティションをロードします。
クエリ	入力したすべての条件に一致するクエリ結果を表示します。
リリース	コレクションまたはパーティションをリリースします。
検索	ベクトル類似検索またはハイブリッド検索を実行します。
表示	接続、データベース、コレクション、loading_progress または index_progress を表示します。
rename	コレクションの名前を変更します。
use	データベースを使用する
バージョン	Milvus_CLIのバージョンを表示します。

インポート

ローカルまたはリモートのデータをパーティションにインポートします。

構文

import -c (text)[-p (text)] <file_path>

オプション

オプション	フルネーム	説明
-c	-コレクション名	データを挿入するコレクションの名前。
-p	-パーティション	(オプション）データを挿入するパーティション名。このパーティション・オプションを渡さないと、"_default" パーティションを選択することになります。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

例1

次の例は、ローカルのCSVファイルをインポートします。

milvus_cli > import -c car 'examples/import_csv/vectors.csv'

Reading csv file...  [####################################]  100%

Column names are ['vector', 'color', 'brand']

Processed 50001 lines.

Inserting ...

Insert successfully.
--------------------------  ------------------
Total insert entities:                   50000
Total collection entities:              150000
Milvus timestamp:           428849214449254403
--------------------------  ------------------

例 2

次の例は、リモートの CSV ファイルをインポートします。

milvus_cli > import -c car 'https://raw.githubusercontent.com/milvus-
io/milvus_cli/main/examples/import_csv/vectors.csv'

Reading file from remote URL.

Reading csv file...  [####################################]  100%

Column names are ['vector', 'color', 'brand']

Processed 50001 lines.

Inserting ...

Insert successfully.

--------------------------  ------------------
Total insert entities:                   50000
Total collection entities:              150000
Milvus timestamp:           428849214449254403
--------------------------  ------------------

ユーザ一覧

すべてのユーザーを一覧表示します。

構文

list users

オプション

| オプション | フルネーム | 説明 | --help | n/a | コマンドの使用に関するヘルプを表示します。|

コレクションをリストする

すべてのコレクションを一覧表示します。

構文

list collections

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

list indexes

コレクションのすべてのインデックスを一覧表示します。

構文

list indexes -c (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

list partitions

コレクションのすべてのパーティションをリストする。

構文

list partitions -c (text)

オプション

オプション	フルネーム	説明
-c	-コレクション名	コレクションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

ロード

コレクションまたはパーティションをハードドライブ領域からRAMにロードします。

構文

load -c (text) [-p (text)]

オプション

オプション	フルネーム	説明
-c	-コレクション名	パーティションが属するコレクションの名前。
-p	-パーティション	(オプション/複数) パーティションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

クエリ

入力したすべての条件に一致するクエリ結果を表示します。

構文

query

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

例1

クエリを実行し、必要な入力を求めるプロンプトを表示する：

milvus_cli > query

Collection name: car

The query expression: id in [ 428960801420883491, 428960801420883492,
428960801420883493 ]

Name of partitions that contain entities(split by "," if multiple) []:
default

A list of fields to return(split by "," if multiple) []: color, brand

timeout []:

Guarantee timestamp. This instructs Milvus to see all operations performed before a provided timestamp. If no such timestamp is provided, then Milvus will search all operations performed to date. [0]:
Graceful time. Only used in bounded consistency level. If graceful_time is set, PyMilvus will use current timestamp minus the graceful_time as the guarantee_timestamp. This option is 5s by default if not set. [5]:

例 2

クエリを実行し、必要な入力を求めるプロンプトを表示する：

milvus_cli > query

Collection name: car

The query expression: id > 428960801420883491

Name of partitions that contain entities(split by "," if multiple) []:
default

A list of fields to return(split by "," if multiple) []: id, color,
brand

timeout []:

Guarantee timestamp. This instructs Milvus to see all operations performed before a provided timestamp. If no such timestamp is provided, then Milvus will search all operations performed to date. [0]:
Graceful time. Only used in bounded consistency level. If graceful_time is set, PyMilvus will use current timestamp minus the graceful_time as the guarantee_timestamp. This option is 5s by default if not set. [5]:

リリース

コレクションまたはパーティションをRAMから解放します。

構文

release -c (text) [-p (text)]

オプション

オプション	フルネーム	説明
-c	-コレクション名	パーティションが属するコレクションの名前。
-p	-パーティション	(オプション/複数）パーティション名。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

検索

ベクトル類似検索またはハイブリッド検索を実行する。

構文

search

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

例1

csvファイルの検索を実行し、必要な入力を求めるプロンプトを表示する：

milvus_cli > search

Collection name (car, test_collection): car

The vectors of search data(the length of data is number of query (nq), the dim of every vector in data must be equal to vector field’s of collection. You can also import a csv file
out headers): examples/import_csv/search_vectors.csv

The vector field used to search of collection (vector): vector

Search parameter nprobe's value: 10

The max number of returned record, also known as topk: 2

The boolean expression used to filter attribute []: id > 0

The names of partitions to search (split by "," if multiple) ['_default'] []: _default

timeout []:

Guarantee Timestamp(It instructs Milvus to see all operations performed before a provided timestamp. If no such timestamp is provided, then Milvus will search all operations performed to date) [0]:

例 2

インデックス付きコレクションで検索を実行し、必要な入力を求めるには：

milvus_cli > search

Collection name (car, test_collection): car

The vectors of search data(the length of data is number of query (nq), the dim of every vector in data must be equal to vector field’s of collection. You can also import a csv file without headers):
    [[0.71, 0.76, 0.17, 0.13, 0.42, 0.07, 0.15, 0.67, 0.58, 0.02, 0.39, 0.47, 0.58, 0.88, 0.73, 0.31, 0.23, 0.57, 0.33, 0.2, 0.03, 0.43, 0.78, 0.49, 0.17, 0.56, 0.76, 0.54, 0.45, 0.46, 0.05, 0.1, 0.43, 0.63, 0.29, 0.44, 0.65, 0.01, 0.35, 0.46, 0.66, 0.7, 0.88, 0.07, 0.49, 0.92, 0.57, 0.5, 0.16, 0.77, 0.98, 0.1, 0.44, 0.88, 0.82, 0.16, 0.67, 0.63, 0.57, 0.55, 0.95, 0.13, 0.64, 0.43, 0.71, 0.81, 0.43, 0.65, 0.76, 0.7, 0.05, 0.24, 0.03, 0.9, 0.46, 0.28, 0.92, 0.25, 0.97, 0.79, 0.73, 0.97, 0.49, 0.28, 0.64, 0.19, 0.23, 0.51, 0.09, 0.1, 0.53, 0.03, 0.23, 0.94, 0.87, 0.14, 0.42, 0.82, 0.91, 0.11, 0.91, 0.37, 0.26, 0.6, 0.89, 0.6, 0.32, 0.11, 0.98, 0.67, 0.12, 0.66, 0.47, 0.02, 0.15, 0.6, 0.64, 0.57, 0.14, 0.81, 0.75, 0.11, 0.49, 0.78, 0.16, 0.63, 0.57, 0.18]]

The vector field used to search of collection (vector): vector

Search parameter nprobe's value: 10

The specified number of decimal places of returned distance [-1]: 5

The max number of returned record, also known as topk: 2

The boolean expression used to filter attribute []: id > 0

The names of partitions to search (split by "," if multiple) ['_default'] []: _default

timeout []:

Guarantee Timestamp(It instructs Milvus to see all operations performed before a provided timestamp. If no such timestamp is provided, then Milvus will search all operations performed to date) [0]:

例3

索引付けされていないコレクションで検索を実行し、必要な入力を求めるには：

milvus_cli > search

Collection name (car, car2): car

The vectors of search data(the length of data is number of query (nq), the dim of every vector in data must be equal to vector field’s of collection. You can also import a csv file without headers): examples/import_csv/search_vectors.csv

The vector field used to search of collection (vector): vector

The specified number of decimal places of returned distance [-1]: 5

The max number of returned record, also known as topk: 2

The boolean expression used to filter attribute []:

The names of partitions to search (split by "," if multiple) ['_default'] []:

timeout []:

Guarantee Timestamp(It instructs Milvus to see all operations performed before a provided timestamp. If no such timestamp is provided, then Milvus will search all operations performed to date) [0]:

リスト接続

接続をリストする。

構文

list connections 

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

show index_progress

エンティティのインデックス作成の進行状況を表示します。

構文

show index_progress -c (text) [-i (text)]

オプション

オプション	フルネーム	説明
-c	-コレクション名	エンティティが属するコレクションの名前。
-i	-インデックス	(オプション) インデックスの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

show loading_progress

コレクションのロードの進行状況を表示します。

構文

show loading_progress -c (text) [-p (text)]

オプション

オプション	フルネーム	説明
-c	-コレクション名	エンティティが属するコレクションの名前。
-p	-パーティション	(オプション/複数) ロード・パーティションの名前。
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示する。

バージョン

Milvus_CLIのバージョンを表示します。

構文

version

オプション

オプション	フルネーム	説明
-ヘルプ	n/a	コマンドの使用に関するヘルプを表示します。

例

$ milvus_cli --version
Milvus_CLI v0.4.0