Référence de la commande Milvus_CLI
L'interface de ligne de commande (CLI) de Milvus est un outil de ligne de commande qui prend en charge la connexion à la base de données, les opérations sur les données, ainsi que l'importation et l'exportation de données.
Cette rubrique présente toutes les commandes prises en charge et les options correspondantes. Quelques exemples sont également inclus à titre de référence.
clear (effacer)
Efface l'écran.
Syntaxe
clear
Options
Option | Nom complet | Description |
---|---|---|
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
connect
Se connecte à Milvus.
Syntaxe
connect [-uri (text)] [-t (text)]
Options
Option | Nom complet | Description de l'option |
---|---|---|
-uri | -uri | (Facultatif) Nom de l'uri. La valeur par défaut est "http://127.0.0.1:19530". |
-t | -token | (Facultatif) L'apikey du nuage zilliz ou username:password . La valeur par défaut est None. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > connect -uri http://127.0.0.1:19530
créer une base de données
Créer une base de données dans Milvus
Syntaxe de la commande
create database -db (text)
Options de la commande
Option | Nom complet | Description de l'option |
---|---|---|
-db | -database | [Le nom de la base de données dans milvus. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemples d'utilisation
Exemple 1
L'exemple suivant crée la base de données testdb
dans milvus.
milvus_cli > create database -db testdb
utiliser la base de données
Utiliser la base de données dans Milvus
Syntaxe
use database -db (text)
Options
Option | Nom complet | Description de l'option |
---|---|---|
-db | -database | [Le nom de la base de données dans milvus. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemples d'utilisation
Exemple 1
L'exemple suivant utilise la base de données testdb
dans milvus.
milvus_cli > use database -db testdb
Liste des bases de données
Liste des bases de données dans Milvus
Syntaxe
list databases
Exemples de base de données
Exemple 1
L'exemple suivant répertorie les bases de données dans Milvus.
milvus_cli > list databases
supprimer la base de données
Supprimer une base de données dans Milvus
Syntaxe
delete database -db (text)
Options
Option | Nom complet | Description de l'option |
---|---|---|
-db | -database | [Le nom de la base de données dans milvus. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemples d'utilisation
Exemple 1
L'exemple suivant supprime la base de données testdb
dans milvus.
milvus_cli > delete database -db testdb
créer un utilisateur
Créer un utilisateur dans Milvus
Syntaxe
create user -u (text) -p (text)
Options
Option | Nom complet | Description de l'utilisateur |
---|---|---|
-p | -mot de passe | Le mot de passe de l'utilisateur en milvus. La valeur par défaut est "None". |
-u | -Nom d'utilisateur | Le nom d'utilisateur dans milvus. La valeur par défaut est "None". |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemples d'utilisation
Exemple 1
L'exemple suivant crée l'utilisateur zilliz
et le mot de passe zilliz
dans milvus.
milvus_cli > create user -u zilliz -p zilliz
create alias
Spécifie des alias uniques pour une collection.
Syntaxe
create alias -c (text) -a (text) [-A]
Options
Option | Nom complet | Description de l'alias |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-a | -Nom de l'alias | L'alias. |
-A | -alter | (Facultatif) Indicateur permettant de transférer l'alias dans une collection spécifique. |
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
Exemples d'utilisation
Exemple 1
L'exemple suivant crée les alias carAlias1
et carAlias2
pour la collection car
.
milvus_cli > create alias -c car -a carAlias1
Exemple 2
L'exemple suivant transfère l'alias carAlias1
de la collection car
à la collection car2
.
milvus_cli > create alias -c car2 -A -a carAlias1
create collection
Crée une collection.
Syntaxe
create collection -c (text) -f (text) -p (text) [-a] [-d (text)]
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-f | -schema-champ | (Multiple) Le schéma du champ au format <fieldName>:<dataType>:<dimOfVector/desc> . |
-p | -schema-champ-primaire | Le nom du champ de clé primaire. |
-a | -schema-auto-id | (Facultatif) Indicateur permettant de générer automatiquement des identifiants. |
-desc | -Description du schéma | (Facultatif) Description de la collection. |
-level | -Niveau de cohérence | (Facultatif) Niveau de cohérence : Bounded, Session, Strong, Eventual . |
-d | -is-dynamic | (Facultatif) Le schéma de collecte prend en charge ou non les champs dynamiques. |
-s | -shards-num | (Facultatif) Nombre de shards |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
Exemple
## 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'
create partition
Crée une partition.
Syntaxe de la commande
create partition -c (text) -p (text) [-d (text)]
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-p | -partition | Le nom de la partition. |
-d | -description | (Facultatif) Description de la partition. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > create partition -c car -p new_partition -d test_add_partition
create index
Crée un index pour un champ.
Syntaxe de la commande
create index
Options
Option | Nom complet | Description |
---|---|---|
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
Exemple
Pour créer un index pour un champ et être invité à saisir les données requises :
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
Supprime un utilisateur
Syntaxe de la commande
delete user -u (text)
Options
Option | Nom complet | Description de l'option |
---|---|---|
-u | -Nom d'utilisateur | Le nom d'utilisateur. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > delete user -u zilliz
delete alias
Supprime un alias.
Syntaxe de la commande
delete alias -a (text)
Options
Option de l'alias | Nom complet | Description de l'alias |
---|---|---|
-a | -Nom de l'alias | L'alias. |
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
delete collection
Supprime une collection.
Syntaxe
delete collection -c (text)
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à supprimer. |
-help | n/a | Affiche l'aide à l'utilisation de la commande. |
Exemple
milvus_cli > delete collection -c car
delete entités
Supprime les entités.
Syntaxe de la commande
delete entities -c (text) -p (text)
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle appartiennent les entités à supprimer. |
-p | -partition | (Facultatif) Nom de la partition à supprimer. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
Exemple
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 partition
Supprime une partition.
Syntaxe de la commande
delete partition -c (text) -p (text)
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle appartient la partition à supprimer. |
-p | -partition | Le nom de la partition à supprimer. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > delete partition -c car -p new_partition
delete index
Supprime un index et les fichiers d'index correspondants.
Syntaxe de la commande
delete index -c (text) -in (text)
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-in | -Nom de l'index | Le nom de l'index. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > delete index -c car -in indexName
show collection
Affiche les informations détaillées d'une collection.
Syntaxe
show collection -c (text)
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > show collection -c test_collection_insert
show partition
Affiche les informations détaillées d'une partition.
Syntaxe
show partition -c (text) -p (text)
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle la partition appartient. |
-p | -partition | Le nom de la partition. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
Exemple
milvus_cli > show partition -c test_collection_insert -p _default
show index
Affiche les informations détaillées d'un index.
Syntaxe
show index -c (text) -in (text)
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-in | -Nom de l'index | Le nom de l'index. |
--help | n/a | Affiche l'aide à l'utilisation de la commande. |
Exemple
milvus_cli > show index -c test_collection -in index_name
exit
Ferme la fenêtre de la ligne de commande.
Syntaxe
exit
Options
Option | Nom complet | Description |
---|---|---|
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
help
Affiche l'aide pour l'utilisation d'une commande.
Syntaxe
help <command>
Commandes
Commande | Description de la commande |
---|---|
effacer | Efface l'écran. |
connect | Se connecte à Milvus. |
créer | Crée une collection, une base de données, une partition, un utilisateur et un index. |
supprimer | Supprime une collection, une base de données, une partition, un alias, un utilisateur ou un index. |
exit | Ferme la fenêtre de la ligne de commande. |
help | Affiche l'aide relative à l'utilisation d'une commande. |
insert | Importe des données dans une partition. |
list | Liste les collections, les bases de données, les partitions, les utilisateurs ou les index. |
load | Charge une collection ou une partition. |
requête | Affiche les résultats de la requête qui correspondent à tous les critères que vous avez saisis. |
release | Libère une collection ou une partition. |
recherche | Effectue une recherche de similarité vectorielle ou une recherche hybride. |
show | Affiche la connexion, la base de données, la collection, la progression du chargement ou la progression de l'index. |
renommer | Renomme la collection |
use | Utilise la base de données |
version | Affiche la version de Milvus_CLI. |
import
Importe des données locales ou distantes dans une partition.
Syntaxe
import -c (text)[-p (text)] <file_path>
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection dans laquelle les données sont insérées. |
-p | -partition | (Facultatif) Le nom de la partition dans laquelle les données sont insérées. Le fait de ne pas passer cette option de partition indique que l'on choisit la partition "_default". |
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
Exemple 1
L'exemple suivant importe un fichier 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
-------------------------- ------------------
Exemple 2
L'exemple suivant importe un fichier CSV distant.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
-------------------------- ------------------
list users
Liste tous les utilisateurs.
Syntaxe
list users
Options
| Option | Nom complet | Description | | --help | n/a | Affiche l'aide pour l'utilisation de la commande. |
list collections
Liste toutes les collections.
Syntaxe
list collections
list collections
Options
Option | Nom complet | Description de l'option |
---|---|---|
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
list indexes
Répertorie tous les index d'une collection.
Syntaxe
list indexes -c (text)
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
list partitions
Liste toutes les partitions d'une collection.
Syntaxe
list partitions -c (text)
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection. |
-help | n/a | Affiche l'aide pour l'utilisation de la commande. |
load
Charge une collection ou une partition du disque dur vers la RAM.
Syntaxe
load -c (text) [-p (text)]
Options
Option | Nom complet | Description |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle la partition appartient. |
-p | -partition | (Facultatif/Multiple) Le nom de la partition. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
query
Affiche les résultats de la requête qui correspondent à tous les critères que vous avez saisis.
Syntaxe
query
Options
Option | Nom complet | Description |
---|---|---|
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
Exemple
Exemple 1
Pour effectuer une requête et être invité à saisir les données requises :
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]:
Exemple 2
Pour effectuer une requête et être invité à saisir les données requises :
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]:
libérer
Libère une collection ou une partition de la RAM.
Syntaxe
release -c (text) [-p (text)]
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle la partition appartient. |
-p | -partition | (Facultatif/Multiple) Le nom de la partition. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
search
Effectue une recherche de similarité vectorielle ou une recherche hybride.
Syntaxe
search
Options
Option | Nom complet | Description |
---|---|---|
-help | s.o. | Affiche l'aide à l'utilisation de la commande. |
Exemples d'utilisation
Exemple 1
Pour effectuer une recherche dans un fichier csv et être invité à saisir les données requises :
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]:
Exemple 2
Pour effectuer une recherche sur une collection indexée et être invité à saisir les données requises :
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]:
Exemple 3
Pour effectuer une recherche sur une collection non indexée et être invité à saisir les données requises :
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]:
liste des connexions
Répertorie les connexions.
Syntaxe
list connections
Options
Option | Nom complet | Description |
---|---|---|
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
show index_progress
Affiche la progression de l'indexation de l'entité.
Syntaxe
show index_progress -c (text) [-i (text)]
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle les entités appartiennent. |
-i | -index | (Facultatif) Le nom de l'index. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
show loading_progress
Affiche la progression du chargement d'une collection.
Syntaxe
show loading_progress -c (text) [-p (text)]
Options
Option | Nom complet | Description de l'option |
---|---|---|
-c | -Nom de la collection | Le nom de la collection à laquelle les entités appartiennent. |
-p | -partition | (Facultatif/Multiple) Le nom de la partition de chargement. |
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
version
Affiche la version de Milvus_CLI.
Syntaxe
version
Options
Option | Nom complet | Description de l'option |
---|---|---|
-help | s.o. | Affiche l'aide pour l'utilisation de la commande. |
milvus_cli --version
fait office de commande.Exemple
$ milvus_cli --version
Milvus_CLI v0.4.0