testdb in milvus.
+The following example create the database testdb in milvus.
```shell
milvus_cli > create database -db testdb
@@ -84,21 +84,21 @@ Use Database in Milvus
testdb in milvus.
+The following example use the database testdb in milvus.
```shell
milvus_cli > use database -db testdb
@@ -111,8 +111,9 @@ List Databases in Milvus
testdb in milvus.
+The following example delete the database testdb in milvus.
```shell
milvus_cli > delete database -db testdb
@@ -178,6 +179,33 @@ The following example create the user zilliz and password zil
milvus_cli > create user -u zilliz -p zilliz
```
+## create role
+
+Create role in Milvus
+
+Syntax
+
+```shell
+create role -r (text)
+```
+
+### Options
+
+| Option | Full name | Description |
+| :----- | :--------- | :----------------------------------- |
+| -r | --roleName | The role name of milvus role. |
+| --help | n/a | Displays help for using the command. |
+
+### Examples
+
+#### Example 1
+
+The following example create the role role1 in milvus.
+
+```shell
+milvus_cli > create role -r role1
+```
+
## create alias
Specifies unique aliases for a collection.
@@ -187,17 +215,17 @@ Specifies unique aliases for a collection.
Syntax
```shell
-create alias -c (text) -a (text) [-A]
+create alias -c (text) -a (text) [-A]
```
Options
-| Option | Full name | Description |
-| :----- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -c | --collection-name | The name of the collection. |
-| -a | --alias-name | The alias. |
-| -A | --alter | (Optional) Flag to transfer the alias to a specified collection. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :---------------- | :--------------------------------------------------------------- |
+| -c | --collection-name | The name of the collection. |
+| -a | --alias-name | The alias. |
+| -A | --alter | (Optional) Flag to transfer the alias to a specified collection. |
+| --help | n/a | Displays help for using the command. |
Examples
@@ -240,7 +268,7 @@ create collection -c (text) -f (text) -p (text) [-a] [-d (text)]
| -desc | --schema-description | (Optional) The description of the collection. |
| -level | --consistency-level | (Optional) Consistency level: Bounded,Session,Strong, Eventual . |
| -d | --is-dynamic | (Optional) Collection schema supports dynamic fields or not. |
-| -s | --shards-num | (Optional) Shards number |
+| -s | --shards-num | (Optional) Shards number |
| --help | n/a | Displays help for using the command. |
Example
@@ -308,10 +336,10 @@ 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
+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, ) []:
+Index metric type (L2, IP, HAMMING, TANIMOTO, COSINE, ) []:
Timeout []:
```
@@ -339,6 +367,31 @@ delete user -u (text)
milvus_cli > delete user -u zilliz
```
+## delete role
+
+Delete role in Milvus
+
+Syntax
+
+```shell
+delete role -r (text)
+```
+
+### Options
+
+| Option | Full name | Description |
+| :----- | :--------- | :----------------------------------- |
+| -r | --roleName | The role name of milvus role. |
+| --help | n/a | Displays help for using the command. |
+
+### Examples
+
+The following example delete the role role1 in milvus.
+
+```shell
+milvus_cli > delete role -r role1
+```
+
## delete alias
Deletes an alias.
@@ -346,15 +399,15 @@ Deletes an alias.
Syntax
```shell
-delete alias -a (text)
+delete alias -a (text)
```
Options
-| Option | Full name | Description |
-| :----- | :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -a | --alias-name | The alias. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :----------- | :----------------------------------- |
+| -a | --alias-name | The alias. |
+| --help | n/a | Displays help for using the command. |
| |
## delete collection
@@ -364,15 +417,15 @@ Deletes a collection.
Syntax
```shell
-delete collection -c (text)
+delete collection -c (text)
```
Options
-| Option | Full name | Description |
-| :----- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -c | --collection-name | The name of the collection to be deleted. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :---------------- | :---------------------------------------- |
+| -c | --collection-name | The name of the collection to be deleted. |
+| --help | n/a | Displays help for using the command. |
Example
@@ -387,16 +440,16 @@ Deletes entities.
Syntax
```
-delete entities -c (text) -p (text)
+delete entities -c (text) -p (text)
```
Options
-| Option | Full name | Description |
-| :----- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -c | --collection-name | The name of the collection that entities to be deleted belongs to. |
-| -p | --partition | (Optional) The name of the partition to be deleted. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :---------------- | :----------------------------------------------------------------- |
+| -c | --collection-name | The name of the collection that entities to be deleted belongs to. |
+| -p | --partition | (Optional) The name of the partition to be deleted. |
+| --help | n/a | Displays help for using the command. |
Example
@@ -422,11 +475,11 @@ delete partition -c (text) -p (text)
Options
-| Option | Full name | Description |
-| :----- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -c | --collection-name | The name of the collection that the partition to be deleted belongs to. |
-| -p | --partition | The name of the partition to be deleted. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :---------------- | :---------------------------------------------------------------------- |
+| -c | --collection-name | The name of the collection that the partition to be deleted belongs to. |
+| -p | --partition | The name of the partition to be deleted. |
+| --help | n/a | Displays help for using the command. |
Example
@@ -446,20 +499,96 @@ Deletes an index and the corresponding index files.
delete index -c (text) -in (text)
```
-Options
+Options
-| Option | Full name | Description |
-| :----- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -c | --collection-name | The name of the collection. |
-| -in | --index-name | The name of the index name. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :---------------- | :----------------------------------- |
+| -c | --collection-name | The name of the collection. |
+| -in | --index-name | The name of the index name. |
+| --help | n/a | Displays help for using the command. |
-Example
+Example
```shell
milvus_cli > delete index -c car -in indexName
```
+## grant role
+
+Grant role to user
+
+Syntax
+
+Options
+
+| Option | Full name | Description |
+| :----- | :--------- | :----------------------------------- |
+| -r | --roleName | The role name of milvus role. |
+| -u | --username | The username of milvus user. |
+| --help | n/a | Displays help for using the command. |
+
+Example
+
+```shell
+grant role -r role1 -u user1
+```
+
+## grant privilege
+
+Assigns a privilege to a role.
+
+Syntax
+
+Options
+
+| Option | Full name | Description |
+| :----- | :-------- | :----------------------------------- |
+| --help | n/a | Displays help for using the command. |
+
+Example
+
+```shell
+grant privilege
+```
+
+## revoke role
+
+Revokes the role assigned to a user.
+
+Syntax
+
+Options
+
+| Option | Full name | Description |
+| :----- | :--------- | :----------------------------------- |
+| -r | --roleName | The role name of milvus role. |
+| -u | --username | The username of milvus user. |
+| --help | n/a | Displays help for using the command. |
+
+Example
+
+```shell
+grant role -r role1 -u user1
+```
+
+## revoke privilege
+
+Revokes a privilege already assigned to a role.
+
+Syntax
+
+Options
+
+| Option | Full name | Description |
+| :----- | :-------- | :----------------------------------- |
+| --help | n/a | Displays help for using the command. |
+
+Example
+
+```shell
+revoke privilege
+```
+
## show collection
Shows the detailed information of a collection.
@@ -531,6 +660,7 @@ show index -c (text) -in (text)
```shell
milvus_cli > show index -c test_collection -in index_name
```
+
## exit
Closes the command line window.
@@ -559,24 +689,26 @@ help
Commands
-| Command | Description |
-| :----------- | :------------------------------------------------------------------------------------------------------------------ |
-| clear | Clears the screen. |
-| connect | Connects to Milvus. |
-| create | Create collection, database, partition,user and index. |
-| delete | Delete collection, database, partition,alias,user or index. |
-| exit | Closes the command line window. |
-| help | Displays help for using a command. |
-| insert | Imports data into a partition. |
-| list | List collections,databases, partitions,users or indexes. |
-| load | Loads a collection or partition. |
-| query | Shows query results that match all the criteria that you enter. |
-| release | Releases a collection or partition. |
-| search | Performs a vector similarity search or hybrid search. |
-| show | Show connection, database,collection, loading_progress or index_progress. |
-| rename | Rename collection |
-| use | Use database |
-| version | Shows the version of Milvus_CLI. |
+| Command | Description |
+| :------ | :------------------------------------------------------------------------ |
+| clear | Clears the screen. |
+| connect | Connects to Milvus. |
+| create | Create collection, database, partition,user,role and index. |
+| grant | Grant role, privilege . |
+| revoke | Revoke role, privilege . |
+| delete | Delete collection, database, partition,alias,user,role or index. |
+| exit | Closes the command line window. |
+| help | Displays help for using a command. |
+| insert | Imports data into a partition. |
+| list | List collections,databases, partitions,users,roles,grants or indexes. |
+| load | Loads a collection or partition. |
+| query | Shows query results that match all the criteria that you enter. |
+| release | Releases a collection or partition. |
+| search | Performs a vector similarity search or hybrid search. |
+| show | Show connection, database,collection, loading_progress or index_progress. |
+| rename | Rename collection |
+| use | Use database |
+| version | Shows the version of Milvus_CLI. |
## import
@@ -590,11 +722,11 @@ import -c (text)[-p (text)]
Options
-| Option | Full name | Description |
-| :----- | :---------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -c | --collection-name | The name of the collection that the data are inserted into. |
-| -p | --partition | (Optional) The name of the partition that the data are inserted into. Not passing this partition option indicates choosing the "\_default" partition. |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| -c | --collection-name | The name of the collection that the data are inserted into. |
+| -p | --partition | (Optional) The name of the partition that the data are inserted into. Not passing this partition option indicates choosing the "\_default" partition. |
+| --help | n/a | Displays help for using the command. |
Example 1
The following example imports a local CSV file.
@@ -659,6 +791,47 @@ list users
| Option | Full name | Description |
| --help | n/a | Displays help for using the command. |
+## List roles
+
+List roles in Milvus
+
+Syntax
+
+```shell
+list roles
+```
+
+### Options
+
+| Option | Full name | Description |
+| :----- | :-------- | :----------------------------------- |
+| --help | n/a | Displays help for using the command. |
+
+### Examples
+
+```shell
+milvus_cli > list roles
+```
+
+## List grants
+
+List grants in Milvus
+
+### Options
+
+| Option | Full name | Description |
+| :----- | :----------- | :----------------------------------- |
+| -r | --roleName | The role name of milvus role. |
+| -o | --objectName | The object name of milvus object. |
+| -t | --objectType | Global, Collection or User. |
+| --help | n/a | Displays help for using the command. |
+
+### Examples
+
+```shell
+milvus_cli > list grants -r role1 -o object1 -t Collection
+```
+
## list collections
Lists all collections.
@@ -671,9 +844,9 @@ list collections
Options
-| Option | Full name | Description |
-| :----- | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :-------- | :----------------------------------- |
+| --help | n/a | Displays help for using the command. |
## list indexes
@@ -919,14 +1092,14 @@ List connections.
Syntax
```shell
-list connections
+list connections
```
Options
-| Option | Full name | Description |
-| :----- | :-------- | :---------------------------------------- |
-| --help | n/a | Displays help for using the command. |
+| Option | Full name | Description |
+| :----- | :-------- | :----------------------------------- |
+| --help | n/a | Displays help for using the command. |
## show index_progress
@@ -963,7 +1136,6 @@ show loading_progress -c (text) [-p (text)]
|-p|--partition|(Optional/Multiple) The name of the loading partition.|
|--help|n/a|Displays help for using the command.|
-
## version
Shows the version of Milvus_CLI.
diff --git a/v2.5.x/site/en/userGuide/tools/cli_overview.md b/v2.5.x/site/en/userGuide/tools/cli_overview.md
index 29321f455..7011c2980 100644
--- a/v2.5.x/site/en/userGuide/tools/cli_overview.md
+++ b/v2.5.x/site/en/userGuide/tools/cli_overview.md
@@ -28,12 +28,11 @@ In the following table, you can find the recommended versions of PyMilvus and Mi
| 2.2.x | 2.2.x | 0.4.0 |
| 2.3.x | 2.3.x | 0.4.2 |
| 2.4.x | 2.4.x | 1.0.0 |
-
-
+| 2.4.x | 2.4.x | 1.0.1 |
Milvus 2.0.0-RC7 and later are not backward compatible with 2.0.0-RC6 and earlier due to changes made to storage formats.
## Current version
-The current version of Milvus_CLI is 1.0.0.
+The current version of Milvus_CLI is 1.0.1.
To find your installed version and see if you need to update, run `milvus_cli --version`.
diff --git a/version.json b/version.json
index 8085d97f0..afcd7732d 100644
--- a/version.json
+++ b/version.json
@@ -1,4 +1,4 @@
{
- "version": "v2.4.x",
+ "version": "v2.5.x",
"released": "yes"
}