Referência do Comando Milvus_CLI

O Milvus Command-Line Interface (CLI) é uma ferramenta de linha de comandos que suporta a ligação à base de dados, operações de dados e importação e exportação de dados.

Este tópico apresenta todos os comandos suportados e as opções correspondentes. Alguns exemplos também estão incluídos para sua referência.

limpar

Limpa o ecrã.

Sintaxe

clear

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

ligar

Liga-se ao Milvus.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-uri	-uri	(Opcional) O nome do uri. A predefinição é "http://127.0.0.1:19530".
-t	-token	(Opcional) O apikey do zilliz cloud ou username:password. A predefinição é None (Nenhum).
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

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

criar base de dados

Criar base de dados no Milvus

Sintaxe

create database -db (text) 

Opções

Opção	Nome completo	Descrição
-db	-database	[Obrigatório] O nome da base de dados em milvus.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplos

Exemplo 1

O exemplo seguinte cria a base de dados testdb em milvus.

milvus_cli > create database -db testdb

usar base de dados

Utilizar base de dados em Milvus

Sintaxe

use database -db (text) 

Opções

Opção	Nome completo	Descrição
-db	-database	[Obrigatório] O nome da base de dados em milvus.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplos

Exemplo 1

O exemplo seguinte utiliza a base de dados testdb em milvus.

milvus_cli > use database -db testdb

listar bases de dados

Listar bases de dados em Milvus

Sintaxe

list databases 

Exemplos

Exemplo 1

O exemplo seguinte lista as bases de dados em milvus.

milvus_cli > list databases

apagar base de dados

Eliminar base de dados em Milvus

Sintaxe

delete database -db (text) 

Opções

Opção	Nome completo	Descrição
-db	-database	[Obrigatório] O nome da base de dados em milvus.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplos

Exemplo 1

O exemplo seguinte elimina a base de dados testdb em milvus.

milvus_cli > delete database -db testdb

criar utilizador

Criar utilizador em Milvus

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-p	-senha	A palavra-passe do utilizador em milvus. A predefinição é "Nenhum".
-u	-nome de utilizador	O nome de utilizador em milvus. A predefinição é "None".
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplos

Exemplo 1

O exemplo seguinte cria o utilizador zilliz e a palavra-passe zilliz em milvus.

milvus_cli > create user -u zilliz -p zilliz

criar alias

Especifica aliases únicos para uma coleção.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-a	-alias-nome	O pseudónimo.
-A	-alter	(Opcional) Sinalizador para transferir o alias para uma coleção especificada.
-help	n/a	Apresenta ajuda para a utilização do comando.

Exemplos

Exemplo 1

O exemplo a seguir cria os aliases carAlias1 e carAlias2 para a coleção car.

milvus_cli > create alias -c car -a carAlias1

Exemplo 2

O exemplo a seguir transfere o alias carAlias1 da coleção car para a coleção car2.

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

criar coleção

Cria uma coleção.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-f	-schema-campo	(Múltiplo) O esquema do campo no formato <fieldName>:<dataType>:<dimOfVector/desc>.
-p	-schema-primary-field	O nome do campo de chave primária.
-a	-schema-auto-id	(Opcional) Sinalizador para gerar IDs automaticamente.
-desc	-schema-description	(Opcional) A descrição da coleção.
-level	-consistency-level	(Opcional) Nível de consistência: Bounded,Session,Strong, Eventual .
-d	-is-dynamic	(Opcional) O esquema de coleção suporta ou não campos dinâmicos.
-s	-shards-num	(Opcional) Número de fragmentos
-help	n/a	Apresenta ajuda para a utilização do comando.

Exemplo

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

criar partição

Cria uma partição.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-p	-partição	O nome da partição.
-d	-descrição	(Opcional) A descrição da partição.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

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

criar índice

Cria um índice para um campo.

Sintaxe

create index

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

Para criar um índice para um campo e ser solicitado a introduzir os dados necessários:

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

Sintaxe

delete user -u (text)

Opções

Opção	Nome completo	Descrição
-u	-nome de utilizador	O nome de utilizador.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

milvus_cli > delete user -u zilliz

delete alias

Elimina um alias.

Sintaxe

delete alias -a (text) 

Opções

Opção	Nome completo	Descrição
-a	-alias-nome	O pseudónimo.
-help	n/a	Apresenta ajuda para utilizar o comando.

delete collection

Elimina uma coleção.

Sintaxe

delete collection -c (text) 

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a ser eliminada.
-help	n/a	Apresenta ajuda para a utilização do comando.

Exemplo

milvus_cli > delete collection -c car

delete entities

Elimina entidades.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a que pertencem as entidades a eliminar.
-p	-partição	(Opcional) O nome da partição a ser eliminada.
-help	n/a	Apresenta ajuda para a utilização do comando.

Exemplo

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 partição

Elimina uma partição.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a que pertence a partição a ser eliminada.
-p	-partição	O nome da partição a ser eliminada.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

milvus_cli > delete partition -c car -p new_partition

delete index

Elimina um índice e os ficheiros de índice correspondentes.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-in	-nome-do-índice	O nome do nome do índice.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

milvus_cli > delete index -c car -in indexName

mostrar coleção

Mostra as informações detalhadas de uma coleção.

Sintaxe

show collection -c (text)

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

milvus_cli > show collection -c test_collection_insert

mostrar partição

Mostra as informações detalhadas de uma partição.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a que a partição pertence.
-p	-partição	O nome da partição.
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

milvus_cli > show partition -c test_collection_insert -p _default

mostrar índice

Mostra as informações detalhadas de um índice.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-in	-nome do índice	O nome do índice.

| --help | n/a | Exibe ajuda para usar o comando. |

Exemplo

milvus_cli > show index -c test_collection -in index_name

exit

Fecha a janela da linha de comando.

Sintaxe

exit

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

help

Apresenta ajuda para a utilização de um comando.

Sintaxe

help <command>

Comandos

Comando	Descrição
Limpar	Limpa o ecrã.
ligar	Liga-se ao Milvus.
criar	Cria uma coleção, uma base de dados, uma partição, um utilizador e um índice.
apagar	Elimina uma coleção, uma base de dados, uma partição, um alias, um utilizador ou um índice.
sair	Fecha a janela da linha de comando.
ajuda	Apresenta ajuda para a utilização de um comando.
insert	Importa dados para uma partição.
listar	Lista colecções, bases de dados, partições, utilizadores ou índices.
carregar	Carrega uma coleção ou partição.
consulta	Mostra os resultados da consulta que correspondem a todos os critérios introduzidos.
liberar	Libera uma coleção ou partição.
pesquisa	Executa uma pesquisa de similaridade de vetor ou uma pesquisa híbrida.
mostrar	Mostra conexão, banco de dados, coleção, loading_progress ou index_progress.
renomear	Renomeia a coleção
usar	Usa a base de dados
versão	Mostra a versão do Milvus_CLI.

importar

Importa dados locais ou remotos para uma partição.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção em que os dados são inseridos.
-p	-partição	(Opcional) O nome da partição na qual os dados são inseridos. Não passar esta opção de partição indica a escolha da partição "_default".
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo 1

O exemplo seguinte importa um ficheiro 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
--------------------------  ------------------

Exemplo 2

O exemplo seguinte importa um ficheiro 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 utilizadores

Lista todos os utilizadores.

Sintaxe

list users

Opções

| Opção | Nome completo | Descrição | --help | n/a | Exibe ajuda para usar o comando. |

listar coleções

Lista todas as coleções.

Sintaxe

list collections

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

listar índices

Lista todos os índices de uma coleção.

Sintaxe

list indexes -c (text)

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-help	n/a	Apresenta ajuda para utilizar o comando.

listar partições

Lista todas as partições de uma coleção.

Sintaxe

list partitions -c (text)

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção.
-help	n/a	Apresenta ajuda para a utilização do comando.

load

Carrega uma coleção ou partição do espaço do disco rígido para a RAM.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a que a partição pertence.
-p	-partição	(Opcional/Múltiplo) O nome da partição.
-help	n/a	Apresenta ajuda para a utilização do comando.

consulta

Mostra os resultados da consulta que correspondem a todos os critérios introduzidos.

Sintaxe

query

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplo

Exemplo 1

Para efetuar uma consulta e ser solicitado a introduzir os dados necessários:

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

Exemplo 2

Para efetuar uma consulta e ser solicitado a introduzir os dados necessários:

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

libertação

Liberta uma coleção ou partição da RAM.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção à qual a partição pertence.
-p	-partição	(Opcional/Múltiplo) O nome da partição.
-help	n/a	Apresenta ajuda para utilizar o comando.

pesquisa

Executa uma pesquisa de similaridade de vetor ou uma pesquisa híbrida.

Sintaxe

search

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

Exemplos

Exemplo 1

Para efetuar uma pesquisa num ficheiro csv e ser solicitado a introduzir os dados necessários:

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

Exemplo 2

Para efetuar uma pesquisa numa coleção indexada e ser solicitado a introduzir os dados necessários:

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

Exemplo 3

Para efetuar uma pesquisa numa coleção não indexada e ser solicitado a introduzir os dados necessários:

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 ligações

Listar ligações.

Sintaxe

list connections 

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta ajuda para utilizar o comando.

show index_progress

Mostra o progresso da indexação de entidades.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a que as entidades pertencem.
-i	-index	(Opcional) O nome do índice.
-help	n/a	Apresenta ajuda para a utilização do comando.

show loading_progress

Apresenta o progresso do carregamento de uma coleção.

Sintaxe

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

Opções

Opção	Nome completo	Descrição
-c	-nome da coleção	O nome da coleção a que as entidades pertencem.
-p	-partição	(Opcional/Múltiplo) O nome da partição de carregamento.
-help	n/a	Apresenta ajuda para utilizar o comando.

version

Mostra a versão do Milvus_CLI.

Sintaxe

version

Opções

Opção	Nome completo	Descrição
-help	n/a	Apresenta a ajuda para a utilização do comando.

Exemplo

$ milvus_cli --version
Milvus_CLI v0.4.0