milvus-logo
LFAI
Home
  • Werkzeuge

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.

löschen

Löscht den Bildschirm.

Syntax

clear

Optionen

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

verbinden

Stellt eine Verbindung zu Milvus her.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-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.
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

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

create Datenbank

Datenbank in Milvus erstellen

Syntax

create database -db (text) 

Optionen

OptionVollständiger NameBeschreibung
-db-database[Erforderlich] Der Name der Datenbank in milvus.
-helpk.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

OptionVollständiger NameBeschreibung
-db-database[Erforderlich] Der Name der Datenbank in milvus.
-helpk.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

OptionVollständiger NameBeschreibung
-db-database[Erforderlich] Der Name der Datenbank in milvus.
-helpk.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

Benutzer anlegen

Anlegen eines Benutzers in Milvus

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-p-PasswortDas Benutzerpasswort in milvus. Die Vorgabe ist "Keines".
-u-BenutzernameDer Benutzername in milvus. Die Vorgabe ist "Keiner".
-helpn/aZeigt 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

alias erstellen

Gibt eindeutige Aliasnamen für eine Sammlung an.

Eine Sammlung kann mehrere Aliasnamen haben. Ein Alias entspricht jedoch maximal einer Sammlung.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-a-alias-nameDer Alias.
-A-alter(Optional) Flagge zum Übertragen des Alias in eine bestimmte Sammlung.
-helpk.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

Beispiel 2 basiert auf Beispiel 1.

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 -c (text) -f (text) -p (text) [-a] [-d (text)]

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-f-schema-feld(Mehrere) Das Feldschema im Format <fieldName>:<dataType>:<dimOfVector/desc>.
-p-schema-primäres-feldDer Name des Primärschlüsselfeldes.
-a-schema-auto-id(Optional) Flag zur automatischen Generierung von IDs.
-desc-schema-description(Optional) Die Beschreibung der Sammlung.
-level-consistency-level(Optional) Konsistenzstufe: Bounded,Session,Strong, Eventual .
-d-ist-dynamisch(Optional) Sammlungsschema unterstützt dynamische Felder oder nicht.
-s-shards-num(Optional) Anzahl der Shards
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

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

Partition erstellen

Erzeugt eine Partition.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-p-partitionDer Name der Partition.
-d-description(Optional) Die Beschreibung der Partition.
-helpn/aZeigt 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.

Derzeit unterstützt eine Sammlung maximal einen Index.

Syntax

create index

Optionen

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

So erstellen Sie einen Index für ein Feld und werden zur Eingabe der erforderlichen Daten aufgefordert:

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

Benutzer löschen

Löscht einen Benutzer

Syntax

delete user -u (text)

Optionen

OptionVollständiger NameBeschreibung
-u-BenutzernameDer Benutzername.
-helpn/aZeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete user -u zilliz

alias löschen

Löscht einen Alias.

Syntax

delete alias -a (text) 

Optionen

OptionVollständiger NameBeschreibung
-a-alias-nameDer Aliasname.
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

delete Sammlung

Löscht eine Sammlung.

Syntax

delete collection -c (text) 

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der zu löschenden Sammlung.
-helpn/aZeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete collection -c car

Entitäten löschen

Löscht Entitäten.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die zu löschenden Entitäten gehören.
-p-partition(Optional) Der Name der zu löschenden Partition.
-helpn/aZeigt 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 ]

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

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die zu löschende Partition gehört.
-p-partitionDer Name der zu löschenden Partition.
-helpn/aZeigt 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.

Derzeit unterstützt eine Sammlung maximal einen Index.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-in-index-nameDer Name des Indexnamens.
-helpn/aZeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

milvus_cli > delete index -c car -in indexName

show collection

Zeigt die detaillierten Informationen einer Sammlung an.

Syntax

show collection -c (text)

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-helpk.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

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die Partition gehört.
-p-partitionDer Name der Partition.
-helpn/aZeigt 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

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-in-index-nameDer 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

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Hilfe

Zeigt die Hilfe zur Verwendung eines Befehls an.

Syntax

help <command>

Befehle

BefehlBeschreibung
löschenLöscht den Bildschirm.
verbindenStellt eine Verbindung zu Milvus her.
erstellenErstellt Sammlung, Datenbank, Partition, Benutzer und Index.
löschenLöschen von Sammlung, Datenbank, Partition, Alias, Benutzer oder Index.
beendenSchließt das Kommandozeilenfenster.
HilfeZeigt die Hilfe zur Verwendung eines Befehls an.
einfügenImportiert Daten in eine Partition.
auflistenListet Sammlungen, Datenbanken, Partitionen, Benutzer oder Indizes auf.
ladenLädt eine Sammlung oder Partition.
AbfrageZeigt Abfrageergebnisse an, die allen von Ihnen eingegebenen Kriterien entsprechen.
freigebenGibt eine Sammlung oder Partition frei.
SucheFührt eine Vektorähnlichkeitssuche oder eine hybride Suche durch.
anzeigenZeigt Verbindung, Datenbank, Sammlung, Ladefortschritt oder Indexfortschritt an.
umbenennenSammlung umbenennen
verwendenDatenbank verwenden
VersionZeigt die Version von Milvus_CLI an.

importieren

Importiert lokale oder entfernte Daten in eine Partition.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, in die die Daten eingefügt werden.
-p-partition(Optional) Der Name der Partition, in die die Daten eingefügt werden. Wenn Sie diese Partitionsoption nicht angeben, wird die Partition "_default" gewählt.
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel 1

Das folgende Beispiel importiert eine lokale CSV-Datei.

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

Beispiel 2

Das folgende Beispiel importiert eine entfernte CSV-Datei.

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

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. |

Sammlungen auflisten

Listet alle Sammlungen auf.

Syntax

list collections

Optionen

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Indizes auflisten

Listet alle Indizes für eine Sammlung auf.

Derzeit unterstützt eine Sammlung maximal einen Index.

Syntax

list indexes -c (text)

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

list partitions

Listet alle Partitionen einer Sammlung auf.

Syntax

list partitions -c (text)

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung.
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

laden

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

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die Partition gehört.
-p-partition(Optional/Mehrfach) Der Name der Partition.
-helpn/aZeigt die Hilfe zur Verwendung des Befehls an.

Abfrage

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

Syntax

query

Optionen

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Beispiel

Beispiel 1

Um eine Abfrage durchzuführen und zur Eingabe der erforderlichen Daten aufgefordert zu werden:

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

Beispiel 2

So führen Sie eine Abfrage durch und werden zur Eingabe der erforderlichen Daten aufgefordert:

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

freigeben

Gibt eine Sammlung oder Partition aus dem RAM frei.

Syntax

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

Optionen

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die Partition gehört.
-p-partition(Optional/Mehrfach) Der Name der Partition.
-helpn/aZeigt die Hilfe zur Verwendung des Befehls an.

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

search

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.

Durchführen einer Suche in einer csv-Datei und Aufforderung zur Eingabe der erforderlichen Daten:

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

So führen Sie eine Suche in einer indizierten Sammlung durch und werden zur Eingabe der erforderlichen Daten aufgefordert:

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

So führen Sie eine Suche in einer nicht indizierten Sammlung durch und werden zur Eingabe der erforderlichen Daten aufgefordert:

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

Verbindung auflisten

Verbindungen auflisten.

Syntax

list connections 

Optionen

OptionVollständiger NameBeschreibung
-helpk.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

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die Entitäten gehören.
-i-index(Optional) Der Name des Indexes.
-helpn/aZeigt 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

OptionVollständiger NameBeschreibung
-c-sammlung-nameDer Name der Sammlung, zu der die Entitäten gehören.
-p-partition(Optional/Mehrfach) Der Name der Ladepartition.
-helpn/aZeigt die Hilfe zur Verwendung des Befehls an.

Version

Zeigt die Version von Milvus_CLI an.

Syntax

version

Optionen

OptionVollständiger NameBeschreibung
-helpk.A.Zeigt die Hilfe zur Verwendung des Befehls an.
Sie können die Version von Milvus_CLI auch in einer Shell überprüfen, wie im folgenden Beispiel gezeigt. In diesem Fall wirkt milvus_cli --version wie ein Befehl.

Beispiel

$ milvus_cli --version
Milvus_CLI v0.4.0