Справочник команд Milvus_CLI

Milvus Command-Line Interface (CLI) - это инструмент командной строки, который поддерживает подключение к базе данных, операции с данными, а также импорт и экспорт данных.

В этой теме представлены все поддерживаемые команды и соответствующие опции. Некоторые примеры также включены для справки.

Группы команд

Команды Milvus CLI разбиты на следующие группы:

• create: : Создать коллекцию, базу данных, раздел, пользователя, роль или индекс.
• delete: Удалить коллекцию, базу данных, раздел, псевдоним, пользователя, роль или индекс
• list: Список коллекций, баз данных, разделов, пользователей, ролей, грантов или индексов.
• show: Показать соединение, базу данных, коллекцию, прогресс_загрузки или прогресс_индекса
• grant: Предоставить роль или привилегию
• revoke: Отменить роль или привилегию
• load: Загрузить коллекцию или раздел
• release: Освободить коллекцию или раздел
• use: Использовать базу данных
• rename: Переименовать коллекцию
• insert: Вставить сущности (файл или строку)

очистить

Очищает экран.

Синтаксис

clear

Опции

Опция	Полное имя	Описание
-help	н/а	Отображает справку по использованию команды.

подключиться

Подключение к Milvus.

Синтаксис

connect [-uri (text)] [-t (text)]
connect [-uri (text)] [-t (text)] [-tls (0|1)] [-cert (text)]

Опции

Опция	Полное имя	Описание
-uri	-uri	(Необязательно) Имя uri. По умолчанию - "http://127.0.0.1:19530".
-t	-token	(Необязательно) apikey облака zilliz или username:password. По умолчанию - None.
-tls	-tlsmode	(Необязательно) Установка режима TLS: 0 (Без шифрования), 1 (Одностороннее шифрование), 2 (Двустороннее шифрование пока не поддерживается). По умолчанию 0
-cert	-cert	(Необязательно) Путь к файлу сертификата клиента. Работа с односторонним шифрованием
-help	n/a	Отображает справку по использованию команды.

Пример

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

создать базу данных

Создание базы данных в Milvus

Синтаксис

create database -db (text)

Опции

Опция	Полное имя	Описание
-db	-db_name	[Требуется] Имя базы данных в milvus.
-help	n/a	Отображает справку по использованию команды.

Примеры

Пример 1

В следующем примере создается база данных testdb в milvus.

milvus_cli > create database -db testdb

использовать базу данных

Использовать базу данных в Milvus

Синтаксис

use database -db (text)

Опции

Опция	Полное имя	Описание
-db	-db_name	[Требуется] Имя базы данных в milvus.
-help	n/a	Отображает справку по использованию команды.

Примеры

Пример 1

В следующем примере используется база данных testdb в milvus.

milvus_cli > use database -db testdb

список баз данных

Список баз данных в Milvus

Синтаксис

list databases

Примеры

Пример 1

В следующем примере перечислены базы данных в Milvus.

milvus_cli > list databases

удалить базу данных

Удалить базу данных в Milvus

Синтаксис

delete database -db (text)

Опции

Опция	Полное имя	Описание
-db	-db_name	[Требуется] Имя базы данных в milvus.
-help	n/a	Отображает справку по использованию команды.

Примеры

Пример 1

В следующем примере удаляется база данных testdb в milvus.

milvus_cli > delete database -db testdb

Warning! You are trying to delete the database. This action cannot be undone!
Do you want to continue? [y/N]: y

создать пользователя

Создание пользователя в Milvus

Синтаксис

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

Опции

Опция	Полное имя	Описание
-p	-пароль	Пароль пользователя в формате milvus. По умолчанию используется значение "None".
-u	-имя пользователя	Имя пользователя в milvus. По умолчанию - "Нет".
-help	n/a	Отображает справку по использованию команды.

Примеры

Пример 1

В следующем примере создается пользователь zilliz и пароль zilliz в milvus.

milvus_cli > create user -u zilliz -p zilliz

создать роль

Создание роли в Milvus

Синтаксис

create role -r (text)

Опции

Опция	Полное имя	Описание
-r	-roleName	Имя роли milvus.
-help	n/a	Отображает справку по использованию команды.

Примеры

Пример 1

В следующем примере создается роль role1 в milvus.

milvus_cli > create role -r role1

создать псевдоним

Задает уникальные псевдонимы для коллекции.

Синтаксис

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

Параметры

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-a	-alias-name	Псевдоним.
-A	-alter	(Необязательно) Флаг для передачи псевдонима в указанную коллекцию.
-help	n/a	Отображает справку по использованию команды.

Примеры

Пример 1

В следующем примере создаются псевдонимы carAlias1 и carAlias2 для коллекции car.

milvus_cli > create alias -c car -a carAlias1

Пример 2

В следующем примере псевдоним carAlias1 переносится из коллекции car в коллекцию car2.

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

создать коллекцию

Создает коллекцию.

Синтаксис

create collection

Интерактивный пример

milvus_cli > create collection

Please input collection name: car
Please input auto id [False]: False
Please input description []: car collection
Is support dynamic field [False]: False
Please input consistency level(Strong(0),Bounded(1), Session(2), and Eventually(3)) [1]: 1
Please input shards number [1]: 1

Field name: id
Field type (INT64, VARCHAR, FLOAT_VECTOR, etc.): INT64
Field description []: primary key
Is id the primary key? [y/N]: y

Field name: vector
Field type (INT64, VARCHAR, FLOAT_VECTOR, etc.): FLOAT_VECTOR
Field description []: vector field
Dimension: 128

Field name: color
Field type (INT64, VARCHAR, FLOAT_VECTOR, etc.): INT64
Field description []: color field
Nullable [False]: False
Default value (type: INT64) [Not set]: 0

Do you want to add embedding function? [y/N]: n

создать раздел

Создает раздел.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-p	-partition	Имя раздела.
-d	-description	(Необязательно) Описание раздела.
-help	n/a	Отображает справку по использованию команды.

Пример

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

создать индекс

Создает индекс для поля.

Синтаксис

create index

Интерактивный Пример

milvus_cli > create index

Collection name (car, car2): car2
The name of the field to create an index for (vector): vector
Index name: vectorIndex
Index type (FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, RNSG, HNSW, ANNOY, AUTOINDEX, DISKANN, GPU_IVF_FLAT, GPU_IVF_PQ, SPARSE_INVERTED_INDEX, SCANN, STL_SORT, Trie, INVERTED): IVF_FLAT
Vector Index metric type (L2, IP, HAMMING, TANIMOTO, COSINE): L2
Index params nlist: 2
Timeout []:

удалить пользователя

Удаляет пользователя

Синтаксис

delete user -u (text)

Опции

Опция	Полное имя	Описание
-u	-имя пользователя	Имя пользователя.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > delete user -u zilliz

Warning! You are trying to delete the user in milvus. This action cannot be undone!
Do you want to continue? [y/N]: y

удалить роль

Удаление роли в Milvus

Синтаксис

delete role -r (text)

Опции

Опция	Полное имя	Описание
-r	-roleName	Имя роли milvus.
-help	n/a	Отображает справку по использованию команды.

Примеры

В следующем примере удаляется роль role1 в milvus.

milvus_cli > delete role -r role1

удалить псевдоним

Удаляет псевдоним.

Синтаксис

delete alias -a (text)

Опции

Опция	Полное имя	Описание
-a	-alias-name	Псевдоним.
-help	n/a	Отображает справку по использованию команды.

удалить коллекцию

Удаляет коллекцию.

Синтаксис

delete collection -c (text)

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя удаляемой коллекции.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > delete collection -c car

Warning! You are trying to delete the collection. This action cannot be undone!
Do you want to continue? [y/N]: y

удалить сущности

Удаляет сущности.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, к которой принадлежат удаляемые сущности.
-p	-partition	(Необязательно) Имя удаляемого раздела.
-help	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 ]

Warning! 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	-collection-name	Имя коллекции, к которой принадлежит удаляемый раздел.
-p	-partition	Имя удаляемого раздела.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > delete partition -c car -p new_partition

удалить индекс

Удаляет индекс и соответствующие индексные файлы.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-in	-index-name	Имя индекса.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > delete index -c car -in indexName

Warning! You are trying to delete the index of collection. This action cannot be undone!
Do you want to continue? [y/N]: y

предоставить роль

Предоставление роли пользователю

Синтаксис

grant role -r (text) -u (text)

Опции

Опция	Полное имя	Описание
-r	-roleName	Имя роли milvus.
-u	-username	Имя пользователя milvus.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > grant role -r role1 -u user1

присвоить привилегию

Назначает привилегию роли.

Синтаксис

grant privilege

Интерактивный пример

milvus_cli > grant privilege

Role name: role1
The type of object for which the privilege is to be assigned. (Global, Collection, User): Collection
The name of the object to control access for: object1
The name of the privilege to assign. (CreateCollection, DropCollection, etc.): CreateCollection
The name of the database to which the object belongs. [default]: default

отозвать роль

Отменяет роль, назначенную пользователю.

Синтаксис

revoke role -r (text) -u (text)

Опции

Опция	Полное имя	Описание
-r	-roleName	Имя роли milvus.
-u	-username	Имя пользователя milvus.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > revoke role -r role1 -u user1

отменить привилегию

Отменяет привилегию, уже назначенную роли.

Синтаксис

revoke privilege

Интерактивный пример

milvus_cli > revoke privilege

Role name: role1
The type of object for which the privilege is to be assigned. (Global, Collection, User): Collection
The name of the object to control access for: object1
The name of the privilege to assign. (CreateCollection, DropCollection, etc.): CreateCollection
The name of the database to which the object belongs. [default]: default

показать коллекцию

Показывает подробную информацию о коллекции.

Синтаксис

show collection -c (text)

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > show collection -c test_collection_insert

показать раздел

Показывает подробную информацию о разделе.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, к которой принадлежит раздел.
-p	-partition	Имя раздела.
-help	n/a	Отображает справку по использованию команды.

Пример

milvus_cli > show partition -c test_collection_insert -p _default

показать индекс

Показывает подробную информацию об индексе.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-in	-index-name	Имя индекса.

| --help | n/a | Отображает справку по использованию команды. |

Пример

milvus_cli > show index -c test_collection -in index_name

exit

Закрывает окно командной строки.

Синтаксис

exit

Опции

Опция	Полное имя	Описание
-help	н/а	Отображает справку по использованию команды.

help

Отображает справку по использованию команды.

Синтаксис

help <command>

Команды

Команда	Описание
очистить	Очищает экран.
подключиться	Подключение к Milvus.
создать	Создает коллекцию, базу данных, раздел, пользователя, роль и индекс.
grant	Предоставить роль, привилегию.
отозвать	Отменить роль, привилегию .
удалить	Удаление коллекции, базы данных, раздела, псевдонима, пользователя, роли или индекса.
exit	Закрывает окно командной строки.
help	Отображает справку по использованию команды.
вставить	Импортирует данные в раздел.
list	Вывод списка коллекций, баз данных, разделов, пользователей, ролей, грантов или индексов.
load	Загружает коллекцию или раздел.
запрос	Показывает результаты запроса, соответствующие всем введенным критериям.
освободить	Высвобождает коллекцию или раздел.
поиск	Выполняет поиск векторного сходства или гибридный поиск.
показать	Показать соединение, базу данных, коллекцию, ход загрузки_прогресса или ход индекса_прогресса.
переименовать	Переименовать коллекцию
использовать	Использовать базу данных
версия	Показывает версию Milvus_CLI.

вставить

Импортирует локальные или удаленные данные в раздел.

Синтаксис

insert file -c (text) [-p (text)] [-t (text)] <file_path>

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, в которую вставляются данные.
-p	-partition	(Необязательно) Имя раздела, в который вставляются данные. Если не передавать этот параметр раздела, то будет выбран раздел "_default".
-t	-timeout	(Необязательно) Необязательная продолжительность времени в секундах, которое должно быть отведено для RPC. Если таймаут не задан, клиент продолжает ждать, пока сервер не ответит или не произойдет ошибка.
-help	n/a	Отображает справку по использованию команды.

Пример 1

В следующем примере импортируется локальный CSV-файл.

milvus_cli > insert file -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 > insert file -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
--------------------------  ------------------

вставить строку

Вставляет строку данных в коллекцию.

Синтаксис

insert row

Интерактивный пример

milvus_cli > insert row

Collection name: car
Partition name [_default]: _default
Enter value for id (INT64): 1
Enter value for vector (FLOAT_VECTOR): [1.0, 2.0, 3.0]
Enter value for color (INT64): 100
Enter value for brand (VARCHAR): Toyota

Inserted successfully.

список пользователей

Выводит список всех пользователей.

Синтаксис

list users

Опции

| Опция | Полное имя | Описание | | --help | n/a | Отображает справку по использованию команды. |

Список ролей

Список ролей в Milvus

Синтаксис

list roles

Опции

Опция	Полное имя	Описание
-help	н/а	Отображает справку по использованию команды.

Примеры

milvus_cli > list roles

Перечислить гранты

Перечислить гранты в Milvus

Опции

Опция	Полное название	Описание
-r	-roleName	Имя роли milvus.
-o	-objectName	Имя объекта milvus.
-t	-objectType	Глобальный, Коллекция или Пользователь.
-help	n/a	Отображает справку по использованию команды.

Примеры

milvus_cli > list grants -r role1 -o object1 -t Collection

список коллекций

Выводит список всех коллекций.

Синтаксис

list collections

Опции

Опция	Полное имя	Описание
-help	н/а	Отображает справку по использованию команды.

список индексов

Выводит список всех индексов для коллекции.

Синтаксис

list indexes -c (text)

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-help	n/a	Отображает справку по использованию команды.

список разделов

Выводит список всех разделов коллекции.

Синтаксис

list partitions -c (text)

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции.
-help	n/a	Отображает справку по использованию команды.

загрузить

Загружает коллекцию или раздел с жесткого диска в оперативную память.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, к которой принадлежит раздел.
-p	-partition	(Необязательно/многократно) Имя раздела.
-help	n/a	Отображает справку по использованию команды.

запрос

Показывает результаты запроса, соответствующие всем введенным критериям.

Синтаксис

query

Интерактивный Пример

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]:

освободить

Освобождает коллекцию или раздел из оперативной памяти.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, к которой принадлежит раздел.
-p	-partition	(Необязательно/многократно) Имя раздела.
-help	n/a	Отображает справку по использованию команды.

search

Выполняет поиск векторного сходства или гибридный поиск.

Синтаксис

search

Интерактивный пример

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): 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]:

список соединений

Вывод списка соединений.

Синтаксис

list connections

Опции

Опция	Полное имя	Описание
-help	н/а	Отображает справку по использованию команды.

show index_progress

Показывает прогресс индексирования сущностей.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, к которой принадлежат сущности.
-i	-index	(Необязательно) Имя индекса.
-help	n/a	Отображает справку по использованию команды.

show loading_progress

Отображает ход загрузки коллекции.

Синтаксис

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

Опции

Опция	Полное имя	Описание
-c	-collection-name	Имя коллекции, к которой принадлежат сущности.
-p	-partition	(Необязательно/многократно) Имя раздела загрузки.
-help	n/a	Отображает справку по использованию команды.

версия

Показывает версию Milvus_CLI.

Синтаксис

version

Опции

Опция	Полное имя	Описание
-help	н/а	Отображает справку по использованию команды.

Пример

$ milvus_cli --version
Milvus_CLI v0.4.0