Referencia de comandos Milvus_CLI

La interfaz de línea de comandos (CLI) de Milvus es una herramienta de línea de comandos que soporta la conexión a bases de datos, operaciones de datos e importación y exportación de datos.

Este tema presenta todos los comandos soportados y las opciones correspondientes. También se incluyen algunos ejemplos para su referencia.

borrar

Borra la pantalla.

Sintaxis

clear

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

conectar

Conecta con Milvus.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-uri	-uri	(Opcional) El nombre uri. Por defecto es "http://127.0.0.1:19530".
-t	-token	(Opcional) El apikey de la nube de zilliz o username:password. Por defecto es None.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

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

crear Base de Datos

Crear Base de Datos en Milvus

Sintaxis

create database -db (text)

Opciones

Opción	Nombre completo	Descripción
-db	-base de datos	[Obligatorio] El nombre de la base de datos en milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

El siguiente ejemplo crea la base de datos testdb en milvus.

milvus_cli > create database -db testdb

use Base de datos

Utilizar base de datos en Milvus

Sintaxis

use database -db (text)

Opciones

Opción	Nombre completo	Descripción
-db	-base de datos	[Obligatorio] El nombre de la base de datos en milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

El siguiente ejemplo utiliza la base de datos testdb en milvus.

milvus_cli > use database -db testdb

list Bases de datos

Listar bases de datos en Milvus

Sintaxis

list databases

Ejemplos

Ejemplo 1

El siguiente ejemplo lista las bases de datos en milvus.

milvus_cli > list databases

delete Base de Datos

Borrar Base de Datos en Milvus

Sintaxis

delete database -db (text)

Opciones

Opción	Nombre completo	Descripción
-db	-base de datos	[Obligatorio] El nombre de la base de datos en milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

El siguiente ejemplo elimina la base de datos testdb en milvus.

milvus_cli > delete database -db testdb

crear usuario

Crear usuario en Milvus

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-p	-contraseña	La contraseña del usuario en milvus. Por defecto es "None".
-u	-nombre de usuario	El nombre de usuario en milvus. Por defecto es "Ninguno".
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

El siguiente ejemplo crea el usuario zilliz y la contraseña zilliz en milvus.

milvus_cli > create user -u zilliz -p zilliz

crear rol

Crear rol en Milvus

Sintaxis

create role -r (text)

Opciones

Opción	Nombre completo	Descripción
-r	-roleName	El nombre del rol de milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

El siguiente ejemplo crea el rol role1 en milvus.

milvus_cli > create role -r role1

crear alias

Especifica alias únicos para una colección.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-a	-alias-nombre	El alias.
-A	-alter	(Opcional) Bandera para transferir el alias a una colección especificada.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

El siguiente ejemplo crea los alias carAlias1 y carAlias2 para la colección car.

milvus_cli > create alias -c car -a carAlias1

Ejemplo 2

El siguiente ejemplo transfiere el alias carAlias1 de la colección car a la colección car2.

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

crear colección

Crea una colección.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	Nombre de la colección.
-f	-esquema-campo	(Múltiple) El esquema de campo en el formato <fieldName>:<dataType>:<dimOfVector/desc>.
-p	-schema-campo-principal	El nombre del campo de clave primaria.
-a	-schema-auto-id	(Opcional) Bandera para generar IDs automáticamente.
-desc	-schema-description	(Opcional) Descripción de la colección.
-level	-nivel de coherencia	(Opcional) Nivel de consistencia: Limitado,Sesión,Fuerte, Eventual .
-d	-is-dynamic	(Opcional) El esquema de recogida admite o no campos dinámicos.
-s	-shards-num	(Opcional) Número de fragmentos
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

## 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'

crear partición

Crea una partición.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-p	-partición	El nombre de la partición.
-d	-description	(Opcional) La descripción de la partición.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

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

crear índice

Crea un índice para un campo.

Sintaxis

create index

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

Para crear un índice para un campo y que se le solicite la entrada requerida:

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

Elimina un usuario

Sintaxis

delete user -u (text)

Opciones

Opción	Nombre completo	Descripción
-u	-Nombre de usuario	El nombre de usuario.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

milvus_cli > delete user -u zilliz

borrar rol

Borrar rol en Milvus

Sintaxis

delete role -r (text)

Opciones

Opción	Nombre completo	Descripción
-r	-roleName	El nombre del rol de milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

El siguiente ejemplo elimina el rol role1 en milvus.

milvus_cli > delete role -r role1

eliminar alias

Elimina un alias.

Sintaxis

delete alias -a (text)

Opciones

Opción	Nombre completo	Descripción
-a	-nombre-del-alias	El alias.
-help	n/a	Muestra la ayuda para utilizar el comando.

eliminar colección

Elimina una colección.

Sintaxis

delete collection -c (text)

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección que se va a eliminar.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

milvus_cli > delete collection -c car

borrar entidades

Elimina las entidades.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenecen las entidades que se van a eliminar.
-p	-partición	(Opcional) El nombre de la partición que se va a eliminar.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

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

borrar partición

Elimina una partición.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenece la partición a borrar.
-p	-partición	El nombre de la partición a borrar.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

milvus_cli > delete partition -c car -p new_partition

borrar índice

Elimina un índice y los archivos de índice correspondientes.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-en	-nombre-índice	El nombre del índice.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

milvus_cli > delete index -c car -in indexName

otorgar rol

Conceder rol al usuario

Sintaxis

Opciones

Opción	Nombre completo	Descripción
-r	-roleName	El nombre del rol de milvus.
-u	-nombredeusuario	El nombre de usuario de milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

grant role -r role1 -u user1

otorgar privilegio

Asigna un privilegio a un rol.

Sintaxis

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

grant privilege

revocar rol

Revoca el rol asignado a un usuario.

Sintaxis

Opciones

Opción	Nombre completo	Descripción
-r	-roleName	El nombre del rol de milvus.
-u	-nombredeusuario	El nombre de usuario de milvus.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

grant role -r role1 -u user1

revocar privilegio

Revoca un privilegio ya asignado a un rol.

Sintaxis

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

revoke privilege

mostrar colección

Muestra la información detallada de una colección.

Sintaxis

show collection -c (text)

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

milvus_cli > show collection -c test_collection_insert

mostrar partición

Muestra la información detallada de una partición.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenece la partición.
-p	-partición	El nombre de la partición.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

milvus_cli > show partition -c test_collection_insert -p _default

mostrar índice

Muestra la información detallada de un índice.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-en	-nombre-índice	El nombre del índice.

| --help | n/a | Muestra la ayuda para utilizar el comando. |

Ejemplo

milvus_cli > show index -c test_collection -in index_name

salir

Cierra la ventana de la línea de comandos.

Sintaxis

exit

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra ayuda para utilizar el comando.

ayuda

Muestra la ayuda para utilizar un comando.

Sintaxis

help <command>

Comandos

Comando	Descripción
borrar	Borra la pantalla.
conectar	Se conecta a Milvus.
crear	Crea colección, base de datos, partición, usuario, rol e índice.
conceder	Conceder rol, privilegio .
revocar	Revocar rol, privilegio .
borrar	Borrar colección, base de datos, partición, alias, usuario, rol o índice.
salir	Cierra la ventana de línea de comandos.
ayuda	Muestra la ayuda para utilizar un comando.
insertar	Importa datos a una partición.
list	Lista colecciones, bases de datos, particiones, usuarios, roles, concesiones o índices.
cargar	Carga una colección o partición.
consulta	Muestra los resultados de la consulta que coinciden con los criterios introducidos.
liberar	Libera una colección o partición.
buscar	Realiza una búsqueda de similitud vectorial o una búsqueda híbrida.
mostrar	Muestra la conexión, la base de datos, la colección, el progreso de carga o el progreso del índice.
renombrar	Renombra la colección
utilizar	Usar base de datos
versión	Muestra la versión de Milvus_CLI.

importar

Importa datos locales o remotos a una partición.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección en la que se insertan los datos.
-p	-partición	(Opcional) El nombre de la partición en la que se insertan los datos. Si no se pasa esta opción de partición, se elige la partición "_por defecto".
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo 1

El siguiente ejemplo importa un archivo CSV local.

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

Ejemplo 2

El siguiente ejemplo importa un archivo CSV remoto.

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

listar usuarios

Lista todos los usuarios.

Sintaxis

list users

Opciones

| Opción | Nombre completo | Descripción | | --help | n/a | Muestra la ayuda para utilizar el comando. |

Listar roles

Listar roles en Milvus

Sintaxis

list roles

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

milvus_cli > list roles

Listar subvenciones

Listar subvenciones en Milvus

Opciones

Opción	Nombre completo	Descripción
-r	-roleName	El nombre del rol de milvus.
-o	-objectName	El nombre del objeto de milvus.
-t	-Tipo de objeto	Global, Colección o Usuario.
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

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

listar colecciones

Lista todas las colecciones.

Sintaxis

list collections

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

listar índices

Lista todos los índices de una colección.

Sintaxis

list indexes -c (text)

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-help	n/a	Muestra la ayuda para utilizar el comando.

listar particiones

Lista todas las particiones de una colección.

Sintaxis

list partitions -c (text)

Opciones

Opción	Nombre completo	Descripción
-c	-Nombre de la colección	El nombre de la colección.
-help	n/a	Muestra la ayuda para utilizar el comando.

cargar

Carga una colección o partición desde el disco duro a la memoria RAM.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenece la partición.
-p	-partición	(Opcional/Múltiple) El nombre de la partición.
-help	n/a	Muestra la ayuda para utilizar el comando.

consulta

Muestra los resultados de la consulta que coinciden con todos los criterios introducidos.

Sintaxis

query

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

Ejemplo 1

Para realizar una consulta y que se le soliciten los datos necesarios:

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

Ejemplo 2

Para realizar una consulta y que se le soliciten los datos necesarios:

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

liberar

Libera una colección o partición de la RAM.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenece la partición.
-p	-partición	(Opcional/Múltiple) El nombre de la partición.
-help	n/a	Muestra la ayuda para utilizar el comando.

búsqueda

Realiza una búsqueda de similitud vectorial o una búsqueda híbrida.

Sintaxis

search

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplos

Ejemplo 1

Para realizar una búsqueda en un archivo csv y que se le solicite la entrada requerida:

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

Ejemplo 2

Para realizar una búsqueda en una colección indexada y que se le soliciten los datos necesarios:

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

Ejemplo 3

Para realizar una búsqueda en una colección no indexada y que se le soliciten los datos necesarios:

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

listar conexiones

Listar conexiones.

Sintaxis

list connections

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

show index_progress

Muestra el progreso de la indexación de entidades.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenecen las entidades.
-i	-index	(Opcional) El nombre del índice.
-help	n/a	Muestra la ayuda para utilizar el comando.

mostrar_progreso_carga

Muestra el progreso de carga de una colección.

Sintaxis

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

Opciones

Opción	Nombre completo	Descripción
-c	-nombre-de-la-colección	El nombre de la colección a la que pertenecen las entidades.
-p	-partición	(Opcional/Múltiple) El nombre de la partición de carga.
-help	n/a	Muestra la ayuda para utilizar el comando.

versión

Muestra la versión de Milvus_CLI.

Sintaxis

version

Opciones

Opción	Nombre completo	Descripción
-help	n/a	Muestra la ayuda para utilizar el comando.

Ejemplo

$ milvus_cli --version
Milvus_CLI v0.4.0