Interfaccia a riga di comando di Milvus (CLI)

L'interfaccia a riga di comando di Milvus (CLI) è uno strumento a riga di comando che supporta la connessione al database, le operazioni sui dati, l'importazione e l'esportazione dei dati. Basato sul Milvus Python SDK, consente di eseguire comandi tramite prompt interattivi dalla riga di comando attraverso il terminale.

Versione attuale

La versione attuale di Milvus CLI è 0.4.0. Per trovare la versione installata e determinare se è necessario un aggiornamento, eseguire il comando milvus_cli --version.

Installazione di Milvus CLI

Ecco come installare Milvus CLI.

Installa da PyPI

È possibile installare Milvus CLI da PyPI.

Prerequisiti

Usare pip per installare

Eseguire il seguente comando per installare Milvus CLI.

pip install milvus-cli

Installa tramite Docker

È possibile installare Milvus CLI tramite Docker.

Prerequisiti

È richiesta la versione 19.03 o successiva di Docker.

Installa dall'immagine Docker

$ docker run -it zilliz/milvus_cli:latest

Installa dal codice sorgente

  1. Eseguire il seguente comando per scaricare il repository milvus_cli.
git clone https://github.com/zilliztech/milvus_cli.git
  1. Eseguire il seguente comando per entrare nella cartella milvus_cli.
cd milvus_cli
  1. Eseguire il seguente comando per installare Milvus CLI.
python -m pip install --editable .

In alternativa, è possibile installare Milvus CLI anche da un tarball compresso (file .tar.gz). Scaricare il tarball e poi eseguire python -m pip install milvus_cli-.tar.gz.

Installa da file .exe

Questo metodo di installazione è applicabile solo a Windows.

Scaricare un file .exe da GitHub ed eseguirlo per installare Milvus CLI. In caso di successo, verrà visualizzato un milvus_cli-.exe come mostrato nell'immagine qui sotto.

Milvus_CLI

Riferimento dei comandi di Milvus CLI

Ecco l'elenco di tutti i comandi supportati con le relative opzioni, compresi alcuni esempi a titolo informativo.

clear

Cancella il contenuto dello schermo.

Sintassi

clear

Opzioni

Opzione Nome completo Descrizione
--help N/A Visualizza le informazioni di aiuto per l'uso di questo comando.

connect

Connetti a Milvus.

Sintassi

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

Opzioni

Opzione Nome completo Descrizione
-uri --uri (Opzionale) Nome dell'URI. Predefinito a "http://127.0.0.1:19530".
-t --token (Opzionale) apikey del cloud zilliz o username:password. Predefinito a Nessuno.
--help N/A Visualizza le informazioni di aiuto per l'uso di questo comando.

Esempio

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

create Database

Crea un database in Milvus.

Sintassi

create database -db (testo)

Opzioni

Opzione Nome completo Descrizione
-db --database [Obbligatorio] Il nome del database in Milvus.
--help n/a Visualizza le informazioni di aiuto per l'uso di questo comando.

Esempio

Esempio 1

Il seguente esempio crea un database chiamato testdb in Milvus.

milvus_cli > create database -db testdb

Use Database

Usa un database in Milvus.

Sintassi

use database -db (testo)

Opzioni

Opzione Nome completo Descrizione
-db --database [Obbligatorio] Il nome del database in Milvus.
--help n/a Mostra l'aiuto per l'uso del comando.

Esempio

Esempio 1

Nel seguente esempio viene utilizzato un database chiamato testdb in Milvus.

milvus_cli > use database -db testdb

Elenco dei database

Elenca i database in Milvus.

Sintassi

elenco database

Esempio

Esempio 1

Nel seguente esempio vengono elencati i database in Milvus.

milvus_cli > list databases

Elimina database

Elimina un database in Milvus.

Sintassi

elimina database -db (testo)

Opzioni

Opzione Nome completo Descrizione
-db --database [Obbligatorio] Il nome del database in Milvus.
--help n/a Mostra l'aiuto per l'uso del comando.

Esempio

Esempio 1

Nel seguente esempio viene eliminato un database chiamato testdb in Milvus.

milvus_cli > delete database -db testdb

Crea utente

Crea un utente in Milvus.

Sintassi

crea utente -u (testo) -p (testo)

Opzioni

Opzione Nome completo Descrizione
-p --password La password dell'utente in Milvus. Il valore predefinito è "Nessuno".
-u --username Il nome utente in Milvus. Il valore predefinito è "Nessuno".
--help n/a Mostra l'aiuto per l'uso del comando.

Esempio

Esempio 1

Nel seguente esempio viene creato un utente con il nome utente zilliz e la password zilliz in Milvus.

milvus_cli > create user -u zilliz -p zilliz

Crea alias

Assegna un alias univoco per una raccolta.

Una raccolta può avere più alias, ma a un alias corrisponde solo una raccolta.

Sintassi

crea alias -c (testo) -a (testo) [-A]

Opzioni

Opzione Nome completo Descrizione
-c --collection-name Il nome della raccolta.
-a --alias-name L'alias.
-A --alter (Opzionale) Flag per trasferire un alias a una raccolta specificata.
--help n/a Mostra l'aiuto per l'uso del comando.

Esempio

Esempio 1

Nel seguente esempio vengono creati gli alias carAlias1 e carAlias2 per una raccolta chiamata car.

milvus_cli > create alias -c car -a carAlias1

Esempio 2

L'esempio 2 si basa sull'Esempio 1.

Nel seguente esempio si sposta l'alias carAlias1 dalla raccolta car alla raccolta car2.

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

Crea raccolta

Crea una raccolta.

Sintassi

crea raccolta -c (testo) -f (testo) -p (testo) [-a] [-d (testo)]

Opzioni

Opzione Nome completo Descrizione
-c --collection-name Nome della raccolta.
-f --schema-field (multiplo) Modelli di campo nel formato di ::.
-p --schema-primary-field Nome del campo chiave primaria.
-a --schema-auto-id (opzionale) Flag per la generazione automatica dell'ID.
-desc --schema-description (opzionale) Descrizione della raccolta.
-level --consistency-level (opzionale) Livello di coerenza: limitato, sessione, forte, eventuale.
-d --is-dynamic (opzionale) Se lo schema della raccolta supporta campi dinamici.
-s --shards-num (opzionale) Numero di shard.
--help n/a Mostra l'uso del comando.

Esempio

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

Crea partizione

Crea una partizione.

Sintassi

crea partizione -c (testo) -p (testo) [-d (testo)]

Opzioni

Opzione Nome completo Descrizione
-c --nome-raccolta Nome della raccolta.
-p --partizione Nome della partizione.
-d --descrizione (opzionale) Descrizione della partizione.
--aiuto n/a Visualizza l'aiuto sull'uso del comando.

Esempio

milvus_cli > crea partizione -c auto -p nuova_partizione -d test_aggiungi_partizione

Crea Indice

Crea un indice per un campo.

Attualmente, una raccolta supporta al massimo un indice.

Sintassi

crea indice

Opzioni

Opzione Nome completo Descrizione
--aiuto n/a Visualizza l'aiuto sull'uso del comando.

Esempio

Per creare un indice per un campo e richiedere le informazioni necessarie:

milvus_cli > crea indice

Nome della raccolta (auto, auto2): auto2

Nome del campo per creare un indice (vettore): vettore

Nome indice: indiceVettore

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

Tipo metrica indice (L2, IP, HAMMING, TANIMOTO,): L2

Parametro nlist dell'indice: 2

Timeout []:

Elimina Utente

Elimina un utente.

Sintassi

elimina utente -u (testo)

Opzioni

Opzione Nome completo Descrizione
-u --nome-utente Nome utente.
--aiuto n/a Visualizza l'aiuto sull'uso del comando.

Esempio

milvus_cli > elimina utente -u zilliz

Elimina Alias

Elimina un alias.

Sintassi

elimina alias -a (testo)

Opzioni

Opzione Nome completo Descrizione
-a --nome-alias Alias.
--aiuto n/a Visualizza l'aiuto sull'uso del comando.

Elimina Raccolta

Elimina una raccolta.

Sintassi

elimina raccolta -c (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-raccolta Il nome della raccolta da eliminare.
--aiuto n/a Visualizza l'aiuto sull'uso del comando.

Esempio

milvus_cli > elimina raccolta -c auto

Elimina Elementi

Elimina elementi.

Sintassi

elimina elementi -c (testo) -p (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-raccolta Il nome della raccolta a cui l'entità appartiene.
-p --partizione (Opzionale) Il nome della partizione da eliminare.
--aiuto n/a Visualizza informazioni su come utilizzare il comando.

Esempio

milvus_cli > elimina elementi -c veicoli

Specifica l'espressione per gli elementi da eliminare, ad esempio "ID film in [0,1]": ID film in [0,1]

Stai cercando di eliminare gli elementi dalla raccolta. Questa operazione non può essere annullata!
Continuare con questa operazione? [y/N]: y

Elimina Partizione

Elimina una partizione.

Sintassi

elimina partizione -c (testo) -p (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-raccolta Il nome della raccolta a cui appartiene la partizione.
-p --partizione Il nome della partizione da eliminare.
--aiuto n/a Visualizza informazioni su come utilizzare il comando.

Esempio

milvus_cli > elimina partizione -c veicoli -p nuova_partizione

Elimina Indice

Elimina l'indice e i file di indice corrispondenti.

Attualmente, una raccolta supporta fino a un indice.

Sintassi

elimina indice -c (testo) -in (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione.
-in --nome-indice Il nome dell'indice.
--help n/a Visualizza informazioni sull'utilizzo del comando.

Esempio

milvus_cli > delete index -c veicoli -in nome_indice

Descrivere Collezione

Visualizza informazioni dettagliate sulla collezione.

Sintassi

show collection -c (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione.
--help n/a Visualizza informazioni sull'utilizzo del comando.

Esempio

milvus_cli > show collection -c test_collection_insert

Descrivere Partizione

Visualizza informazioni dettagliate sulla partizione.

Sintassi

show partition -c (testo) -p (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione a cui appartiene la partizione.
-p --partizione Il nome della partizione.
--help n/a Visualizza informazioni sull'utilizzo del comando. 
milvus_cli > show partition -c test_collection_insert -p _default

Descrizione Indice

Visualizza informazioni dettagliate sull'indice.

Sintassi

show index -c (testo) -in (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione.
-in --nome-indice Il nome dell'indice.
--help n/a Visualizza informazioni sull'utilizzo del comando.

Esempio

milvus_cli > show index -c test_collection -in nome_indice

Uscita

Chiudi la finestra della riga di comando.

Sintassi

exit

Opzioni

Opzione Nome completo Descrizione
--help n/a Visualizza informazioni sull'utilizzo del comando.

Aiuto

Visualizza le informazioni di aiuto per il comando.

Sintassi

help

Comandi

Comando Descrizione
calc Calcola la distanza tra due array di vettori, che possono essere mkts_from_hybridts, mkts_from_unixtime, hybridts_to_unixtime.
clear Pulisci lo schermo.
connect Connetti a Milvus.
create Crea una collezione, partizione, indice, o alias.
delete Elimina una collezione, partizione, indice, entità, o alias.
describe Descrivi una collezione, partizione, o indice.
exit Chiudi la finestra della riga di comando.
help Visualizza le informazioni di aiuto per il comando.
import Importa dati in una partizione.
list Elenca collezioni, partizioni, o indici.
load Carica una collezione o partizione in memoria.
load_balance Esegue il bilanciamento del carico sul nodo di interrogazione.
query Visualizza i risultati della query che soddisfano tutte le condizioni di input.
release Rilascia una collezione o partizione.
search Esegui una ricerca di similarità vettoriale o ricerca ibrida.
show Visualizza la collezione attuale, il progresso del caricamento dell'entità, il progresso dell'indicizzazione dell'entità, o le informazioni del segmento.
version Visualizza la versione di Milvus_CLI.

Importazione

Importa dati locali o remoti in una partizione.

Sintassi

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

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione in cui verranno inseriti i dati.
-p --partizione (Opzionale) Il nome della partizione in cui verranno inseriti i dati. Omettendo questa opzione di partizione indica la selezione della partizione "_default".
--help n/a Visualizza informazioni sull'utilizzo del comando.

Esempio 1

Nell'esempio seguente viene importato un file CSV locale.

milvus_cli > import -c car 'esempi/importa_csv/vettori.csv'

Lettura del file csv...  [####################################]  100%

Nomi delle colonne ['vettore', 'colore', 'marca']

Linee processate 50001.

Inserimento...

Inserito con successo.
--------------------------  ------------------
Totale entità inserite:             50000
Entità della collezione totale:    150000
Timestamp di Milvus:           428849214449254403
--------------------------  ------------------

Esempio 2

Nell'esempio seguente viene importato un file CSV remoto.

milvus_cli > import -c car 'https://raw.githubusercontent.com/milvus-io/milvus_cli/main/esempi/importa_csv/vettori.csv'

Lettura del file da un URL remoto.

Lettura del file csv...  [####################################]  100%

I nomi delle colonne sono ['vettore', 'colore', 'marca']

Elaborazione di 50001 righe.

Inserimento...

Inserito con successo.

--------------------------  ------------------
Totale entità inserite:                   50000
Entità totali nella collezione:              150000
Timestamp di Milvus:          428849214449254403
--------------------------  ------------------

Elenco utenti

Elenca tutti gli utenti.

Sintassi

elenco utenti

Opzioni

Opzione Nome completo Descrizione
--help n/a Visualizza le informazioni sull'uso di questo comando.

Elenco collezioni

Elenca tutte le collezioni.

Sintassi

elenco collezioni

Opzioni

Opzione Nome completo Descrizione
--help n/a Visualizza le informazioni sull'uso di questo comando.

Elenco indici

Elenca tutti gli indici per una collezione.

Attualmente, una collezione supporta al massimo un indice.

Sintassi

elenco indici -c (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione.
--help n/a Visualizza le informazioni sull'uso di questo comando.

Elenco partizioni

Elenca tutte le partizioni per una collezione.

Sintassi

elenco partizioni -c (testo)

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione.
--help n/a Visualizza le informazioni sull'uso di questo comando.

Carica

Carica da disco in memoria una collezione o una partizione.

Sintassi

carica -c (testo) [-p (testo)]

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione alla quale appartiene la partizione.
-p --partizione (Opzionale/multiple) Il nome della partizione.
--help n/a Visualizza le informazioni sull'uso di questo comando.

Query

Visualizza i risultati della query che corrispondono a tutte le condizioni immesse.

Sintassi

query

Opzioni

Opzione Nome completo Descrizione
--help n/a Visualizza le informazioni sull'uso di questo comando.

Esempio

Esempio 1

Esegui una query e richiedi le informazioni necessarie:

milvus_cli > query

Nome collezione: car

Espressione di query: id in [428960801420883491, 428960801420883492, 428960801420883493]

Nomi delle partizioni che contengono entità (separati da virgole) []: predefinito

Elenco dei campi restituiti (separati da virgole) []: colore, marca

Timeout []:

Timestamp garantito. Questo indica tutte le operazioni eseguite da Milvus prima del timestamp fornito. Se non viene fornito alcun timestamp, Milvus cercherà tutte le operazioni eseguite fino ad ora. [0]: Tempo di grazia. Utilizzato solo nel livello di consistenza vincolato. Se viene impostato il tempo di grazia, PyMilvus sottrae l'attuale timestamp dal tempo di grazia per utilizzarlo come timestamp garantito. Se questa opzione non è impostata, il valore predefinito è 5 secondi. [5]:

Esempio 2

Esegui una query e richiedi le informazioni necessarie:

milvus_cli > query

Nome della collezione: car

Espressione della query: id > 428960801420883491

Nomi delle partizioni che contengono entità (separati da virgole) []: default

Elenco dei campi restituiti (separati da virgole) []: id, colore, marca

Timeout []:

Timestamp garantito. Indica tutte le operazioni eseguite da Milvus prima del timestamp fornito. Se non viene fornito alcun timestamp, Milvus cercherà tutte le operazioni effettuate fino a ora. [0]: Tempo di grazia. Utilizzato solo nel livello di coerenza limitato. Se viene impostato il tempo di grazia, PyMilvus sottrarrà il timestamp corrente dal tempo di grazia da utilizzare come timestamp garantito. Se questa opzione non è impostata, il valore predefinito è di 5 secondi. [5]:

Rilascio

Rilascia la RAM di una collezione o partizione.

Sintassi

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

Opzioni

Opzione Nome completo Descrizione
-c --nome-collezione Il nome della collezione a cui appartiene la partizione.
-p --partizione (Opzionale/multiplo) Il nome della partizione.
--help n/a Mostra le informazioni sull'uso del comando.

Ricerca

Esegui una ricerca di similarità vettoriale o ricerca ibrida.

Sintassi

search

Opzioni

Opzione Nome completo Descrizione
--help n/a Mostra le informazioni sull'uso del comando.

Esempio

Esempio 1

Esegui una ricerca su un file csv e richiedi le informazioni necessarie:

milvus_cli > search

Nome della collezione (car, test_collection): car

Vettori per la ricerca dei dati (la lunghezza dei dati per la query (nq), la dimensione di ciascun vettore nei dati deve essere uguale al campo vettore della collezione. Puoi anche importare un file csv
head): esempi/importa_csv/vettori_ricerca.csv

Campo vettore per la collezione di ricerca (vettore): vettore

Tipo di metrica: L2

Valore di nprobe per parametro di ricerca: 10

Numero massimo di record da restituire, noto anche come topk: 2

Espressione booleana per filtrare le proprietà []: id > 0

Nomi delle partizioni da cercare (separati da virgole) ['_default'] []: _default

Timeout []:

Timestamp garantito (indica che Milvus esegue tutte le operazioni prima del timestamp fornito. Se non viene fornito alcun timestamp, Milvus cercherà tutte le operazioni effettuate fino a ora) [0]:

Esegui una ricerca sulla collezione di indici e richiedi i parametri necessari:

milvus_cli > search

Inserisci il nome della collezione (ad es. car, test_collection): car

Dati vettoriali per la ricerca (la lunghezza dei dati è il numero di dati di query (nq), la dimensione di ciascun vettore deve essere uguale alla dimensione del campo vettoriale nella collezione. È anche possibile importare un file CSV senza una riga di intestazione):
    [[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,20, 0,03, 0,43, 0,78, 0,49, 0,17, 0,56, 0,76, 0,54, 0,45, 0,46, 0,05, 0,10, 0,43, 0,63, 0,29, 0,44, 0,65, 0,01, 0,35, 0,46, 0,66, 0,70, 0,88, 0,07, 0,49, 0,92, 0,57, 0,50, 0,16, 0,77, 0,98, 0,10, 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,70, 0,05, 0,24, 0,03, 0,90, 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,10, 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,60, 0,89, 0,60, 0,32, 0,11, 0,98, 0,67, 0,12, 0,66, 0,47, 0,02, 0,15, 0,60, 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 vettoriale per la ricerca (ad es. vettore): 

Tipo di misurazione della distanza: L2

Valore del parametro di ricerca nprobe: 10

Numero di cifre decimali per le distanze restituite (noto anche come topk): 5

Espressione booleana per filtrare le proprietà ([]): id > 0

Nomi delle partizioni per la ricerca (se multipli, separati da virgole) ['_default'] []: _default

Timeout ([]): 

Garanzia di timestamp (indica a Milvus di considerare tutte le operazioni eseguite prima del timestamp specificato. Se non viene fornito alcun timestamp, Milvus cercherà tutte le operazioni eseguite finora) [0]:

Esempio 3

Ricerca nelle collezioni non indicizzate e richiesta di input:

milvus_cli > search

Nome della collezione (car, car2): car

Vettori per la ricerca dei dati (lunghezza dei dati per il conteggio della query (nq), dimensioni per ciascun vettore nei dati devono essere uguali al campo vettoriale della collezione. Puoi anche importare un file csv senza intestazioni): esempi/import_csv/vettori_ricerca.csv

Campo vettoriale per la ricerca della collezione (vettore): vettore

Cifre decimali delle distanze restituite (-1 indica tutte le cifre): 5

Numero massimo di record restituiti, anche chiamato topk: 2

Espressione booleana per filtrare le proprietà: []

Nomi delle partizioni da cercare (usa ',' per separarli se ce ne sono più): ['_default'] []

Timeout: []

Timestamp garantiti (indica che Milvus considera tutte le operazioni eseguite prima del timestamp fornito. Se il timestamp non viene fornito, Milvus cercherà tutte le operazioni eseguite fino ad ora): [0]

Elencare connessioni

Elencare le connessioni.

Sintassi

elenco connessioni

Opzioni

Opzione Nome completo Descrizione
--help n/a Mostra informazioni utili per utilizzare questo comando.

Mostrare il progresso dell'indice

Mostra il progresso dell'indicizzazione dell'entità.

Sintassi

mostra progresso_indice -c (testo) [-i (testo)]

Opzioni

Opzione Nome completo Descrizione
-c --nome_collezione Il nome della collezione a cui appartiene l'entità.
-i --indice (Facoltativo) Il nome dell'indice.
--help n/a Mostra informazioni utili per utilizzare questo comando.

Mostrare il progresso del caricamento

Mostra il progresso del caricamento dell'entità.

Sintassi

mostra progresso_caricamento -c (testo) [-p (testo)]

Opzioni

Opzione Nome completo Descrizione
-c --nome_collezione Il nome della collezione a cui appartiene l'entità.
-p --partizione (Facoltativo/multiplo) Il nome della partizione da caricare.
--help n/a Mostra informazioni utili per utilizzare questo comando.

versione

Mostra la versione di Milvus_CLI.

Sintassi

versione

Opzioni

Opzione Nome completo Descrizione
--help n/a Mostra informazioni utili per utilizzare questo comando.

È inoltre possibile controllare la versione di Milvus_CLI nella shell, come mostrato nell'esempio seguente. In questo caso, milvus_cli --version funge da comando.

Esempio

$ milvus_cli --version
Milvus_CLI v0.4.0