Milvus_CLI Befehlsreferenz

Die Milvus-Befehlszeilenschnittstelle (CLI) ist ein Befehlszeilenwerkzeug, das Datenbankverbindungen, Datenoperationen sowie den Import und Export von Daten unterstützt.

In diesem Thema werden alle unterstützten Befehle und die entsprechenden Optionen vorgestellt. Zu Ihrer Information sind auch einige Beispiele enthalten.

Befehlsgruppen

Die Milvus CLI-Befehle sind in die folgenden Gruppen unterteilt:

• create: Sammlung, Datenbank, Partition, Benutzer, Rolle oder Index erstellen
• delete: Löschen einer Sammlung, Datenbank, Partition, eines Alias, eines Benutzers, einer Rolle oder eines Indexes
• list: Auflisten von Sammlungen, Datenbanken, Partitionen, Benutzern, Rollen, Berechtigungen oder Indizes
• show: Show connection, database, collection, loading_progress, or index_progress
• grant: Rolle oder Privileg erteilen
• revoke: Rolle oder Privileg entziehen
• load: Sammlung oder Partition laden
• release: Kollektion oder Partition freigeben
• use: Datenbank verwenden
• rename: Sammlung umbenennen
• insert: Entitäten einfügen (Datei oder Zeile)

löschen

Löscht den Bildschirm.

Syntax

clear

Optionen

Option	Vollständiger Name	Beschreibung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

verbinden

Stellt eine Verbindung zu Milvus her.

Syntax

connect [-uri (text)] [-t (text)]
connect [-uri (text)] [-t (text)] [-tls (0|1)] [-cert (text)]

Optionen

Option	Vollständiger Name	Beschreibung
-uri	-uri	(Optional) Der uri-Name. Der Standardwert ist "http://127.0.0.1:19530".
-t	-token	(Optional) Der zilliz cloud apikey oder username:password. Der Standardwert ist None.
-tls	-tlsmode	(Optional) Legt den TLS-Modus fest: 0 (Keine Verschlüsselung), 1 (Einweg-Verschlüsselung), 2 (Zweiweg-Verschlüsselung wird noch nicht unterstützt). Voreinstellung ist 0.
-cert	-cert	(Optional) Pfad zur Client-Zertifikatsdatei. Arbeitet mit einseitiger Verschlüsselung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

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

Datenbank erstellen

Datenbank in Milvus erstellen

Syntax

create database -db (text)

Optionen

Option	Vollständiger Name	Beschreibung
-db	-db_name	[Erforderlich] Der Name der Datenbank in Milvus.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Beispiel 1

Das folgende Beispiel erstellt die Datenbank testdb in milvus.

milvus_cli > create database -db testdb

Datenbank verwenden

Datenbank in Milvus verwenden

Syntax

use database -db (text)

Optionen

Option	Vollständiger Name	Beschreibung
-db	-db_name	[Erforderlich] Der Name der Datenbank in Milvus.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Beispiel 1

Das folgende Beispiel verwendet die Datenbank testdb in milvus.

milvus_cli > use database -db testdb

Datenbanken auflisten

Datenbanken in Milvus auflisten

Syntax

list databases

Beispiele

Beispiel 1

Das folgende Beispiel listet die Datenbanken in Milvus auf.

milvus_cli > list databases

delete Datenbank

Datenbank in Milvus löschen

Syntax

delete database -db (text)

Optionen

Option	Vollständiger Name	Beschreibung
-db	-db_name	[Erforderlich] Der Name der Datenbank in Milvus.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Beispiel 1

Das folgende Beispiel löscht die Datenbank testdb in milvus.

milvus_cli > delete database -db testdb

Warning! You are trying to delete the database. This action cannot be undone!
Do you want to continue? [y/N]: y

Benutzer anlegen

Anlegen eines Benutzers in Milvus

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-p	-Passwort	Das Benutzerpasswort in milvus. Die Vorgabe ist "Keines".
-u	-Benutzername	Der Benutzername in milvus. Die Vorgabe ist "Keiner".
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Beispiel 1

Das folgende Beispiel erstellt den Benutzer zilliz und das Passwort zilliz in milvus.

milvus_cli > create user -u zilliz -p zilliz

Rolle erstellen

Rolle in Milvus erstellen

Syntax

create role -r (text)

Optionen

Option	Vollständiger Name	Beschreibung
-r	-Rollenname	Der Rollenname der milvus-Rolle.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Beispiel 1

Das folgende Beispiel erstellt die Rolle role1 in milvus.

milvus_cli > create role -r role1

alias erstellen

Gibt eindeutige Aliasnamen für eine Sammlung an.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-a	-alias-name	Der Alias.
-A	-alter	(Optional) Flagge zum Übertragen des Alias in eine bestimmte Sammlung.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Beispiel 1

Das folgende Beispiel erstellt die Aliasnamen carAlias1 und carAlias2 für die Sammlung car.

milvus_cli > create alias -c car -a carAlias1

Beispiel 2

Im folgenden Beispiel wird der Alias carAlias1 von der Sammlung car in die Sammlung car2 übertragen.

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

create collection

Erzeugt eine Sammlung.

Syntax

create collection

Interaktives Beispiel

milvus_cli > create collection

Please input collection name: car
Please input auto id [False]: False
Please input description []: car collection
Is support dynamic field [False]: False
Please input consistency level(Strong(0),Bounded(1), Session(2), and Eventually(3)) [1]: 1
Please input shards number [1]: 1

Field name: id
Field type (INT64, VARCHAR, FLOAT_VECTOR, etc.): INT64
Field description []: primary key
Is id the primary key? [y/N]: y

Field name: vector
Field type (INT64, VARCHAR, FLOAT_VECTOR, etc.): FLOAT_VECTOR
Field description []: vector field
Dimension: 128

Field name: color
Field type (INT64, VARCHAR, FLOAT_VECTOR, etc.): INT64
Field description []: color field
Nullable [False]: False
Default value (type: INT64) [Not set]: 0

Do you want to add embedding function? [y/N]: n

Partition erstellen

Erzeugt eine Partition.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-p	-partition	Der Name der Partition.
-d	-description	(Optional) Die Beschreibung der Partition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

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

Index erstellen

Erzeugt einen Index für ein Feld.

Syntax

create index

Interaktiv Beispiel

milvus_cli > create index

Collection name (car, car2): car2
The name of the field to create an index for (vector): vector
Index name: vectorIndex
Index type (FLAT, IVF_FLAT, IVF_SQ8, IVF_PQ, RNSG, HNSW, ANNOY, AUTOINDEX, DISKANN, GPU_IVF_FLAT, GPU_IVF_PQ, SPARSE_INVERTED_INDEX, SCANN, STL_SORT, Trie, INVERTED): IVF_FLAT
Vector Index metric type (L2, IP, HAMMING, TANIMOTO, COSINE): L2
Index params nlist: 2
Timeout []:

Benutzer löschen

Löscht einen Benutzer

Syntax

delete user -u (text)

Optionen

Option	Vollständiger Name	Beschreibung
-u	-Benutzername	Der Benutzername.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete user -u zilliz

Warning! You are trying to delete the user in milvus. This action cannot be undone!
Do you want to continue? [y/N]: y

Rolle löschen

Rolle in Milvus löschen

Syntax

delete role -r (text)

Optionen

Option	Vollständiger Name	Beschreibung
-r	-Rollenname	Der Rollenname der milvus-Rolle.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

Das folgende Beispiel löscht die Rolle role1 in milvus.

milvus_cli > delete role -r role1

alias löschen

Löscht einen Alias.

Syntax

delete alias -a (text)

Optionen

Option	Vollständiger Name	Beschreibung
-a	-alias-name	Der Aliasname.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

delete Sammlung

Löscht eine Sammlung.

Syntax

delete collection -c (text)

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der zu löschenden Sammlung.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete collection -c car

Warning! You are trying to delete the collection. This action cannot be undone!
Do you want to continue? [y/N]: y

Entitäten löschen

Löscht Entitäten.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die zu löschenden Entitäten gehören.
-p	-partition	(Optional) Der Name der zu löschenden Partition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

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 ]

Warning! You are trying to delete the entities of collection. This action cannot be undone!
Do you want to continue? [y/N]: y

Partition löschen

Löscht eine Partition.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die zu löschende Partition gehört.
-p	-partition	Der Name der zu löschenden Partition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete partition -c car -p new_partition

delete index

Löscht einen Index und die zugehörigen Indexdateien.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-in	-index-name	Der Name des Indexnamens.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete index -c car -in indexName

Warning! You are trying to delete the index of collection. This action cannot be undone!
Do you want to continue? [y/N]: y

Rolle gewähren

Dem Benutzer eine Rolle gewähren

Syntax

grant role -r (text) -u (text)

Optionen

Option	Vollständiger Name	Beschreibung
-r	-Rollenname	Der Rollenname der milvus-Rolle.
-u	-Benutzername	Der Benutzername des milvus-Benutzers.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > grant role -r role1 -u user1

Privileg gewähren

Weist einer Rolle ein Privileg zu.

Syntax

grant privilege

Interaktiv Beispiel

milvus_cli > grant privilege

Role name: role1
The type of object for which the privilege is to be assigned. (Global, Collection, User): Collection
The name of the object to control access for: object1
The name of the privilege to assign. (CreateCollection, DropCollection, etc.): CreateCollection
The name of the database to which the object belongs. [default]: default

Rolle entziehen

Widerruft die einem Benutzer zugewiesene Rolle.

Syntax

revoke role -r (text) -u (text)

Optionen

Option	Vollständiger Name	Beschreibung
-r	-Rollenname	Der Rollenname der milvus-Rolle.
-u	-Benutzername	Der Benutzername des milvus-Benutzers.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > revoke role -r role1 -u user1

revoke privilege

Widerruft ein bereits einer Rolle zugewiesenes Privileg.

Syntax

revoke privilege

Interaktiv Beispiel

milvus_cli > revoke privilege

Role name: role1
The type of object for which the privilege is to be assigned. (Global, Collection, User): Collection
The name of the object to control access for: object1
The name of the privilege to assign. (CreateCollection, DropCollection, etc.): CreateCollection
The name of the database to which the object belongs. [default]: default

show collection

Zeigt die detaillierten Informationen einer Sammlung an.

Syntax

show collection -c (text)

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > show collection -c test_collection_insert

show partition

Zeigt die detaillierten Informationen einer Partition an.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die Partition gehört.
-p	-partition	Der Name der Partition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > show partition -c test_collection_insert -p _default

index anzeigen

Zeigt die detaillierten Informationen zu einem Index an.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-in	-index-name	Der Name des Indexes.

| --help | n/a | Zeigt die Hilfe zur Verwendung des Befehls an. |

Beispiel

milvus_cli > show index -c test_collection -in index_name

exit

Schließt das Befehlszeilenfenster.

Syntax

exit

Optionen

Option	Vollständiger Name	Beschreibung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Hilfe

Zeigt die Hilfe zur Verwendung eines Befehls an.

Syntax

help <command>

Befehle

Befehl	Beschreibung
löschen	Löscht den Bildschirm.
verbinden	Stellt eine Verbindung zu Milvus her.
erstellen	Erstellt Sammlung, Datenbank, Partition, Benutzer, Rolle und Index.
gewähren	Rolle, Privileg gewähren.
widerrufen	Rolle, Privileg widerrufen .
löschen	Sammlung, Datenbank, Partition, Alias, Benutzer, Rolle oder Index löschen.
exit	Schließt das Kommandozeilenfenster.
hilfe	Zeigt die Hilfe zur Verwendung eines Befehls an.
einfügen	Importiert Daten in eine Partition.
auflisten	Listet Sammlungen, Datenbanken, Partitionen, Benutzer, Rollen, Berechtigungen oder Indizes auf.
laden	Lädt eine Sammlung oder Partition.
Abfrage	Zeigt Abfrageergebnisse an, die allen von Ihnen eingegebenen Kriterien entsprechen.
freigeben	Gibt eine Sammlung oder Partition frei.
Suche	Führt eine Vektorähnlichkeitssuche oder eine hybride Suche durch.
anzeigen	Zeigt Verbindung, Datenbank, Sammlung, Ladefortschritt oder Indexfortschritt an.
umbenennen	Sammlung umbenennen
verwenden	Datenbank verwenden
Version	Zeigt die Version von Milvus_CLI an.

einfügen

Importiert lokale oder entfernte Daten in eine Partition.

Syntax

insert file -c (text) [-p (text)] [-t (text)] <file_path>

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, in die die Daten eingefügt werden.
-p	-partition	(Optional) Der Name der Partition, in die die Daten eingefügt werden. Wird diese Option nicht angegeben, wird die Partition "_default" gewählt.
-t	-timeout	(Optional) Eine optionale Zeitspanne in Sekunden, die für den RPC zur Verfügung stehen soll. Wenn timeout nicht gesetzt ist, wartet der Client so lange, bis der Server antwortet oder ein Fehler auftritt.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel 1

Das folgende Beispiel importiert eine lokale CSV-Datei.

milvus_cli > insert file -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
--------------------------  ------------------

Beispiel 2

Das folgende Beispiel importiert eine Remote-CSV-Datei.

milvus_cli > insert file -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
--------------------------  ------------------

Zeile einfügen

Fügt eine Datenzeile in eine Sammlung ein.

Syntax

insert row

Interaktives Beispiel

milvus_cli > insert row

Collection name: car
Partition name [_default]: _default
Enter value for id (INT64): 1
Enter value for vector (FLOAT_VECTOR): [1.0, 2.0, 3.0]
Enter value for color (INT64): 100
Enter value for brand (VARCHAR): Toyota

Inserted successfully.

Benutzer auflisten

Listet alle Benutzer auf.

Syntax

list users

Optionen

| Option | Vollständiger Name | Beschreibung | | --help | n/a | Zeigt die Hilfe zur Verwendung des Befehls an. |

Rollen auflisten

Rollen in Milvus auflisten

Syntax

list roles

Optionen

Option	Vollständiger Name	Beschreibung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

milvus_cli > list roles

Förderungen auflisten

Zuschüsse in Milvus auflisten

Optionen

Option	Vollständiger Name	Beschreibung
-r	-Rollenname	Der Rollenname der milvus-Rolle.
-o	-ObjektName	Der Objektname des milvus-Objekts.
-t	-objectType	Global, Sammlung oder Benutzer.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiele

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

list Sammlungen

Listet alle Sammlungen auf.

Syntax

list collections

Optionen

Option	Vollständiger Name	Beschreibung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Indizes auflisten

Listet alle Indizes für eine Sammlung auf.

Syntax

list indexes -c (text)

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

list partitions

Listet alle Partitionen einer Sammlung auf.

Syntax

list partitions -c (text)

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung.
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

laden

Lädt eine Sammlung oder Partition vom Festplattenspeicher in den RAM.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die Partition gehört.
-p	-partition	(Optional/Mehrfach) Der Name der Partition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Abfrage

Zeigt die Abfrageergebnisse an, die allen von Ihnen eingegebenen Kriterien entsprechen.

Syntax

query

Interaktiv Beispiel

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

freigeben

Gibt eine Sammlung oder Partition aus dem RAM frei.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die Partition gehört.
-p	-partition	(Optional/Mehrfach) Der Name der Partition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Suche

Führt eine Vektorähnlichkeitssuche oder eine hybride Suche durch.

Syntax

search

Interaktiv Beispiel

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

list Verbindung

Listet Verbindungen auf.

Syntax

list connections

Optionen

Option	Vollständiger Name	Beschreibung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

show index_progress

Zeigt den Fortschritt der Indizierung von Entitäten an.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die Entitäten gehören.
-i	-index	(Optional) Der Name des Indexes.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

show loading_progress

Zeigt den Fortschritt beim Laden einer Sammlung an.

Syntax

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

Optionen

Option	Vollständiger Name	Beschreibung
-c	-sammlung-name	Der Name der Sammlung, zu der die Entitäten gehören.
-p	-partition	(Optional/Mehrfach) Der Name der Ladepartition.
-help	n/a	Zeigt die Hilfe zur Verwendung des Befehls an.

Version

Zeigt die Version von Milvus_CLI an.

Syntax

version

Optionen

Option	Vollständiger Name	Beschreibung
-help	k.A.	Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

$ milvus_cli --version
Milvus_CLI v0.4.0