Milvus Command Line Interface (CLI)

A Interface de Linha de Comando (CLI) do Milvus é uma ferramenta de linha de comando que oferece suporte à conexão com banco de dados, operações de dados, importação e exportação de dados. Com base no Milvus Python SDK, ela permite a execução de comandos via prompts interativos da linha de comando pelo terminal.

Versão Atual

A versão atual da CLI do Milvus é 0.4.0. Para encontrar a versão instalada e determinar se uma atualização é necessária, execute o comando milvus_cli --version.

Instalando a CLI do Milvus

Aqui está como instalar a CLI do Milvus.

Instalar do PyPI

Você pode instalar a CLI do Milvus a partir do PyPI.

Pré-requisitos

Usando o pip para Instalar

Execute o seguinte comando para instalar a CLI do Milvus.

pip install milvus-cli

Instalar usando Docker

Você pode instalar a CLI do Milvus usando o Docker.

Pré-requisitos

A versão 19.03 ou superior do Docker é necessária.

Instalar a partir da Imagem do Docker

$ docker run -it zilliz/milvus_cli:latest

Instalar a partir do Código Fonte

  1. Execute o seguinte comando para baixar o repositório milvus_cli.
git clone https://github.com/zilliztech/milvus_cli.git
  1. Execute o seguinte comando para entrar na pasta milvus_cli.
cd milvus_cli
  1. Execute o seguinte comando para instalar a CLI do Milvus.
python -m pip install --editable .

Alternativamente, você também pode instalar a CLI do Milvus a partir de um arquivo compactado (.tar.gz). Baixe o tarball e então execute python -m pip install milvus_cli-.tar.gz.

Instalar a partir do Arquivo .exe

Este método de instalação é aplicável apenas ao Windows.

Baixe um arquivo .exe do GitHub e execute-o para instalar a CLI do Milvus. Se for bem-sucedido, um milvus_cli-.exe aparecerá como mostrado na imagem abaixo.

Milvus_CLI

Referência de Comandos da CLI do Milvus

Aqui está a lista de todos os comandos suportados com suas opções correspondentes, incluindo alguns exemplos para referência.

clear

Limpa o conteúdo da tela.

Sintaxe

clear

Opções

Opção Nome Completo Descrição
--help N/A Exibe as informações de ajuda para usar este comando.

connect

Conecta ao Milvus.

Sintaxe

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

Opções

Opção Nome Completo Descrição
-uri --uri (Opcional) Nome do URI. Padrão é "http://127.0.0.1:19530".
-t --token (Opcional) Chave de API do Zilliz Cloud ou username:password. Padrão é Nenhum.
--help N/A Exibe as informações de ajuda para usar este comando.

Exemplo

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

create Database

Cria um banco de dados no Milvus.

Sintaxe

create database -db (texto)

Opções

Opção Nome Completo Descrição
-db --database [Obrigatório] O nome do banco de dados no Milvus.
--help n/a Exibe as informações de ajuda para usar este comando.

Exemplo

Exemplo 1

O seguinte exemplo cria um banco de dados chamado testdb no Milvus.

milvus_cli > create database -db testdb

Use Database

Usa um banco de dados no Milvus.

Sintaxe

use database -db (texto)

Opções

Opção Nome Completo Descrição
-db --database [Obrigatório] O nome do banco de dados no Milvus.
--help n/a Mostra ajuda para usar o comando.

Exemplo

Exemplo 1

O exemplo a seguir usa um banco de dados chamado testdb no Milvus.

milvus_cli > use database -db testdb

Listar Bancos de Dados

Lista os bancos de dados no Milvus.

Sintaxe

list databases

Exemplo

Exemplo 1

O exemplo a seguir lista os bancos de dados no Milvus.

milvus_cli > list databases

Excluir Banco de Dados

Exclui um banco de dados no Milvus.

Sintaxe

delete database -db (texto)

Opções

Opção Nome Completo Descrição
-db --database [Obrigatório] O nome do banco de dados no Milvus.
--help n/a Mostra ajuda para usar o comando.

Exemplo

Exemplo 1

O exemplo a seguir exclui um banco de dados chamado testdb no Milvus.

milvus_cli > delete database -db testdb

Criar Usuário

Cria um usuário no Milvus.

Sintaxe

create user -u (texto) -p (texto)

Opções

Opção Nome Completo Descrição
-p --password A senha do usuário no Milvus. O valor padrão é "None".
-u --username O nome de usuário no Milvus. O valor padrão é "None".
--help n/a Mostra ajuda para usar o comando.

Exemplo

Exemplo 1

O exemplo a seguir cria um usuário com o nome de usuário zilliz e senha zilliz no Milvus.

milvus_cli > create user -u zilliz -p zilliz

Criar Alias

Atribuir um alias único para uma coleção.

Uma coleção pode ter vários aliases, mas um alias corresponde a apenas uma coleção.

Sintaxe

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

Opções

Opção Nome Completo Descrição
-c --collection-name O nome da coleção.
-a --alias-name O alias.
-A --alter (Opcional) Sinal para transferir um alias para uma coleção especificada.
--help n/a Mostra ajuda para usar o comando.

Exemplo

Exemplo 1

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

milvus_cli > create alias -c car -a carAlias1

Exemplo 2

Com base no Exemplo 1.

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

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

Criar Coleção

Criar uma coleção.

Sintaxe

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

Opções

Opção Nome Completo Descrição
-c --collection-name Nome da coleção.
-f --schema-field (múltiplo) Padrões de campo no formato de ::.
-p --schema-primary-field Nome do campo de chave primária.
-a --schema-auto-id (opcional) Sinal para geração automática de ID.
-desc --schema-description (opcional) Descrição da coleção.
-level --consistency-level (opcional) Nível de consistência: Limitado, Sessão, Forte, Eventual.
-d --is-dynamic (opcional) Se o esquema da coleção suporta campos dinâmicos.
-s --shards-num (opcional) Número de shards.
--help n/a Mostra ajuda para usar o comando.

Exemplo

milvus_cli > create collection -c car -f id:INT64:campo_primário -f vector:FLOAT_VECTOR:128 -f color:INT64:cor -f brand:INT64:marca -p id -A -d 'coleção_carros'

Criar Partição

Criar uma partição.

Sintaxe

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

Opções

Opção Nome Completo Descrição
-c --nome-da-coleção Nome da coleção.
-p --partição Nome da partição.
-d --descrição (opcional) Descrição da partição.
--help n/a Exibir ajuda sobre o uso do comando.

Exemplo

milvus_cli > create partition -c carro -p nova_partição -d teste_adicionar_partição

Criar Índice

Cria um índice para um campo.

Atualmente, uma coleção suporta no máximo um índice.

Sintaxe

create index

Opções

Opção Nome Completo Descrição
--help n/a Exibir ajuda sobre o uso do comando.

Exemplo

Para criar um índice para um campo e solicitar as informações necessárias:

milvus_cli > create index

Nome da coleção (carro, carro2): carro2

Nome do campo para criar um índice para (vetor): vetor

Nome do índice: vetorIndex

Tipo de índice (FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, RNSG, HNSW, ANNOY, AUTOINDEX, DISKANN, ) []:  IVF_FLAT  

Tipo métrico do índice (L2, IP, HAMMING, TANIMOTO,): L2

Parâmetro nlist do índice: 2

Timeout []:

Excluir Usuário

Exclui um usuário.

Sintaxe

delete user -u (texto)

Opções

Opção Nome Completo Descrição
-u --nome-de-usuário Nome de usuário.
--help n/a Exibir ajuda sobre o uso do comando.

Exemplo

milvus_cli > delete user -u zilliz

Excluir Alias

Exclui um alias.

Sintaxe

delete alias -a (texto)

Opções

Opção Nome Completo Descrição
-a --nome-do-alias Alias.
--help n/a Exibir ajuda sobre o uso do comando.

Excluir Coleção

Exclui uma coleção.

Sintaxe

delete collection -c (texto)

Opções

Opção Nome Completo Descrição
-c --nome-da-coleção O nome da coleção a ser excluída.
--help n/a Exibir ajuda sobre o uso do comando.

Exemplo

milvus_cli > delete collection -c carro

Excluir Entidades

Exclui entidades.

Sintaxe

delete entities -c (texto) -p (texto)

Opções

Opção Nome Completo Descrição
-c --nome-da-coleção O nome da coleção à qual a entidade pertence.
-p --partição (Opcional) O nome da partição a ser excluída.
--help n/a Exibir informações de ajuda sobre como usar o comando.

Exemplo

milvus_cli > delete entities -c veículos

Especificar a expressão para as entidades a serem excluídas, por exemplo, "IDs do filme em [0,1]": IDs do filme em [0,1]

Você está tentando excluir entidades da coleção. Essa operação não pode ser desfeita!
Continuar com esta operação? [s/N]: s

Excluir Partição

Exclui uma partição.

Sintaxe

delete partition -c (texto) -p (texto)

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 O nome da partição a ser excluída.
--help n/a Exibir informações de ajuda sobre como usar o comando.

Exemplo

milvus_cli > delete partition -c veículos -p nova_partição

Excluir Índice

Exclui o índice e os arquivos de índice correspondentes.

Atualmente, uma coleção suporta até um índice.

Sintaxe

delete index -c (texto) -in (texto)

Opções

Opção Nome completo Descrição
-c --collection-name O nome da coleção.
-in --index-name O nome do índice.
--help n/a Exibir informações de ajuda sobre como usar o comando.

Exemplo

milvus_cli > delete index -c vehicles -in index_name

Descrição da Coleção

Exibir informações detalhadas sobre a coleção.

Sintaxe

show collection -c (texto)

Opções

Opção Nome completo Descrição
-c --collection-name O nome da coleção.
--help n/a Exibir informações de ajuda sobre como usar o comando.

Exemplo

milvus_cli > show collection -c test_collection_insert

Descrição da Partição

Exibir informações detalhadas sobre a partição.

Sintaxe

show partition -c (texto) -p (texto)

Opções

Opção Nome completo Descrição
-c --collection-name O nome da coleção à qual a partição pertence.
-p --partition O nome da partição.
--help n/a Exibir informações de ajuda sobre como usar o comando. 
milvus_cli > show partition -c test_collection_insert -p _default

Descrição do Índice

Exibir informações detalhadas sobre o índice.

Sintaxe

show index -c (texto) -in (texto)

Opções

Opção Nome completo Descrição
-c --collection-name O nome da coleção.
-in --index-name O nome do índice.
--help n/a Exibir informações de ajuda sobre como usar este comando.

Exemplo

milvus_cli > show index -c test_collection -in index_name

Sair

Fechar a janela de linha de comando.

Sintaxe

exit

Opções

Opção Nome completo Descrição
--help n/a Exibir informações de ajuda sobre como usar este comando.

Ajuda

Exibir informações de ajuda para o comando.

Sintaxe

help

Comandos

Comando Descrição
calc Calcular a distância entre duas matrizes de vetores, que podem ser mkts_from_hybridts, mkts_from_unixtime, hybridts_to_unixtime.
clear Limpar a tela.
connect Conectar ao Milvus.
create Criar uma coleção, partição, índice ou alias.
delete Excluir uma coleção, partição, índice, entidade ou alias.
describe Descrever uma coleção, partição ou índice.
exit Fechar a janela de linha de comando.
help Exibir informações de ajuda para o comando.
import Importar dados para uma partição.
list Listar coleções, partições ou índices.
load Carregar uma coleção ou partição na memória.
load_balance Realizar balanceamento de carga no nó de consulta.
query Exibir resultados da consulta que satisfaçam todas as condições de entrada.
release Liberar uma coleção ou partição.
search Realizar busca de similaridade de vetores ou busca híbrida.
show Exibir a coleção atual, o progresso de carregamento de entidades, o progresso de indexação de entidades ou informações de segmento.
version Exibir a versão do Milvus_CLI.

Importar

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

Sintaxe

import -c (texto)[-p (texto)]

Opções

Opção Nome completo Descrição
-c --collection-name O nome da coleção para a qual os dados serão inseridos.
-p --partition (Opcional) O nome da partição para a qual os dados serão inseridos. Omissão desta opção de partição indica a seleção da partição "_default".
--help n/a Exibir informações de ajuda sobre como usar este comando.

Exemplo 1

O seguinte exemplo importa um arquivo CSV local.

milvus_cli > import -c carro 'exemplos/importar_csv/vetores.csv'

Lendo arquivo csv...  [####################################]  100%

Nomes das colunas ['vetor', 'cor', 'marca']

Processado 50001 linhas.

Inserindo...

Inserido com sucesso.
--------------------------  ------------------
Total de entidades inseridas:       50000
Total de entidades da coleção:   150000
Timestamp do Milvus:            428849214449254403
--------------------------  ------------------

Exemplo 2

O seguinte exemplo importa um arquivo CSV remoto.

milvus_cli > import -c carro 'https://raw.githubusercontent.com/milvus-io/milvus_cli/main/exemplos/importar_csv/vetores.csv'

Lendo arquivo de uma URL remota.

Lendo o arquivo csv...  [####################################]  100%

Os nomes das colunas são ['vetor', 'cor', 'marca']

Processando 50001 linhas.

Inserindo...

Inserido com sucesso.

--------------------------  ------------------
Total de entidades inseridas:        50000
Total de entidades na coleção:       150000
Timestamp do Milvus:           428849214449254403
--------------------------  ------------------

Listar usuários

Lista todos os usuários.

Sintaxe

listar usuários

Opções

Opção Nome completo Descrição
--help n/a Exibe informações de uso para este comando.

Listar coleções

Lista todas as coleções.

Sintaxe

listar coleções

Opções

Opção Nome completo Descrição
--help n/a Exibe informações de uso para este comando.

Listar índices

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

Atualmente, uma coleção suporta no máximo um índice.

Sintaxe

listar índices -c (texto)

Opções

Opção Nome completo Descrição
-c --nome-da-coleção O nome da coleção.
--help n/a Exibe informações de uso para este comando.

Listar partições

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

Sintaxe

listar partições -c (texto)

Opções

Opção Nome completo Descrição
-c --nome-da-coleção O nome da coleção.
--help n/a Exibe informações de uso para este comando.

Carregar

Carrega uma coleção ou partição da memória para o disco.

Sintaxe

carregar -c (texto) [-p (texto)]

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 Exibe informações de uso para este comando.

Consulta

Exibe os resultados da consulta que correspondem a todas as condições inseridas.

Sintaxe

consulta

Opções

Opção Nome completo Descrição
--help n/a Exibe informações de uso para este comando.

Exemplo

Exemplo 1

Realize uma consulta e peça as informações necessárias:

milvus_cli > consulta

Nome da coleção: carro

Expressão de consulta: id em [428960801420883491, 428960801420883492, 428960801420883493]

Nomes das partições que contêm entidades (separadas por vírgulas) []: padrão

Lista de campos de retorno (separados por vírgulas) []: cor, marca

Tempo limite []:

Timestamp garantido. Isso indica todas as operações realizadas pelo Milvus antes do timestamp fornecido. Se nenhum timestamp for fornecido, o Milvus pesquisará todas as operações realizadas até agora. [0]: Tempo gracioso. Apenas usado no nível de consistência limitada. Se o tempo gracioso for definido, o PyMilvus subtrairá o timestamp atual do tempo gracioso para usar como timestamp garantido. Se essa opção não for definida, o valor padrão é 5 segundos. [5]:

Exemplo 2

Realize uma consulta e solicite as informações necessárias:

milvus_cli > query

Nome da coleção: car

Expressão da consulta: id > 428960801420883491

Nomes das partições contendo entidades (separados por vírgulas) []: default

Lista de campos a serem retornados (separados por vírgulas) []: id, cor, marca

Tempo limite []:

Carimbo de data/hora garantido. Isso indica todas as operações realizadas pelo Milvus antes do carimbo de data/hora fornecido. Se nenhum carimbo de data/hora for fornecido, o Milvus buscará todas as operações realizadas até agora. [0]: Tempo gracioso. Usado apenas no nível de consistência delimitada. Se o tempo gracioso for definido, o PyMilvus subtrairá o carimbo de data/hora atual do tempo gracioso para usar como carimbo de data/hora garantido. Se esta opção não estiver definida, o valor padrão é 5 segundos. [5]:

Liberar

Libere a RAM de uma coleção ou partição.

Sintaxe

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

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 Exibe informações de uso para o comando.

Pesquisa

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

Sintaxe

search

Opções

Opção Nome Completo Descrição
--help n/a Exibe informações de uso para o comando.

Exemplo

Exemplo 1

Realize uma pesquisa em um arquivo csv e solicite as informações necessárias:

milvus_cli > search

Nome da coleção (car, coleção_teste): car

Vetores para procurar dados (o comprimento dos dados para consulta (nq), a dimensão de cada vetor nos dados deve ser igual ao campo de vetor da coleção. Você também pode importar um arquivo csv
cabeçalho): exemplos/importar_csv/vetores_de_pesquisa.csv

Campo de vetor para a coleção de pesquisa (vetor): vetor

Tipo de métrica: L2

Valor de nprobe para o parâmetro de pesquisa: 10

Número máximo de registros a serem retornados, também conhecido como topk: 2

Expressão booleana para filtrar propriedades []: id > 0

Nomes das partições a serem pesquisadas (separados por vírgulas) ['_default'] []: _default

Tempo limite []:

Carimbo de data/hora garantido (indica que o Milvus executa todas as operações antes do carimbo de data/hora fornecido. Se nenhum carimbo de data/hora for fornecido, o Milvus buscará todas as operações realizadas até agora) [0]:

Realize uma pesquisa na coleção de índices e solicite os parâmetros necessários:

milvus_cli > search

Digite o nome da coleção (por exemplo, car, test_collection): car

Dados vetoriais para a pesquisa (o comprimento dos dados é o número de dados de consulta (nq), a dimensão de cada vetor deve ser igual à dimensão do campo de vetor na coleção. Você também pode importar um arquivo CSV sem uma linha de cabeçalho):
    [[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]]

Campo vetorial para pesquisa (por exemplo, vetor): 

Tipo de medição de distância: L2

Valor do parâmetro de pesquisa nprobe: 10

Número de casas decimais para distâncias retornadas (também conhecido como topk): 5

Expressão booleana para filtrar propriedades ([]): id > 0

Nomes da partição para pesquisa (se múltiplos, separe por vírgulas) ['_default'] []: _default

Tempo limite ([]): 

Garantia de carimbo de data/hora (diz ao Milvus para observar todas as operações realizadas antes do carimbo de data/hora especificado. Se nenhum carimbo de data/hora for fornecido, o Milvus pesquisará todas as operações realizadas até agora) [0]:

Exemplo 3

Pesquisando coleções não indexadas e solicitando entrada:

milvus_cli > search

Nome da coleção (car, car2): car

Vetores para busca de dados (comprimento dos dados para contagem da consulta (nq), as dimensões de cada vetor nos dados devem ser iguais ao campo de vetor da coleção. Você também pode importar um arquivo csv sem cabeçalhos): exemplos/import_csv/search_vectors.csv

Campo de vetor para busca na coleção (vetor): vetor

Casas decimais das distâncias retornadas (-1 indica todas as casas decimais): 5

Número máximo de registros retornados, também conhecido como topk: 2

Expressão booleana para filtrar propriedades: []

Nomes das partições a serem pesquisadas (use ',' para separar se houver várias): ['_default'] []

Tempo limite: []

Carimbos de data/hora garantidos (indica que o Milvus visualiza todas as operações realizadas antes do carimbo de data/hora fornecido. Se o carimbo de data/hora não for fornecido, o Milvus pesquisará todas as operações realizadas até agora): [0]

Listar conexões

Listar conexões.

Sintaxe

list connections

Opções

Opção Nome Completo Descrição
--help n/a Exibir informações de ajuda para usar este comando.

show index_progress

Exibir o progresso da indexação da entidade.

Sintaxe

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

Opções

Opção Nome Completo Descrição
-c --collection-name O nome da coleção à qual a entidade pertence.
-i --index (Opcional) O nome do índice.
--help n/a Exibir informações de ajuda para usar este comando.

show loading_progress

Exibir o progresso do carregamento da entidade.

Sintaxe

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

Opções

Opção Nome Completo Descrição
-c --collection-name O nome da coleção à qual a entidade pertence.
-p --partition (Opcional/múltiplo) O nome da partição a ser carregada.
--help n/a Exibir informações de ajuda para usar este comando.

versão

Exibir a versão do Milvus_CLI.

Sintaxe

versão

Opções

Opção Nome Completo Descrição
--help n/a Exibir informações de ajuda para usar este comando.

Você também pode verificar a versão do Milvus_CLI no shell, como mostrado no exemplo a seguir. Neste caso, milvus_cli --versão age como o comando.

Exemplo

$ milvus_cli --version
Milvus_CLI v0.4.0