diff --git a/localization/v2.5.x/site/en/userGuide/tools/cli_commands.json b/localization/v2.5.x/site/en/userGuide/tools/cli_commands.json index bf839bc6e..5bd8dc34e 100644 --- a/localization/v2.5.x/site/en/userGuide/tools/cli_commands.json +++ b/localization/v2.5.x/site/en/userGuide/tools/cli_commands.json @@ -1 +1 @@ -{"codeList":["clear\n","connect [-uri (text)] [-t (text)]\n","milvus_cli > connect -uri http://127.0.0.1:19530 \n","create database -db (text) \n","milvus_cli > create database -db testdb\n","use database -db (text) \n","milvus_cli > use database -db testdb\n","list databases \n","milvus_cli > list databases\n","delete database -db (text) \n","milvus_cli > delete database -db testdb\n","create user -u (text) -p (text)\n","milvus_cli > create user -u zilliz -p zilliz\n","create alias -c (text) -a (text) [-A] \n","milvus_cli > create alias -c car -a carAlias1\n","milvus_cli > create alias -c car2 -A -a carAlias1\n","create collection -c (text) -f (text) -p (text) [-a] [-d (text)]\n","## For array field: --schema-field support :::(:if Varchar)\n\nmilvus_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'\n","create partition -c (text) -p (text) [-d (text)]\n","milvus_cli > create partition -c car -p new_partition -d test_add_partition\n","create index\n","milvus_cli > create index\n\nCollection name (car, car2): car2\n\nThe name of the field to create an index for (vector): vector\n\nIndex name: vectorIndex\n\n# Default is ''\nIndex 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 \n\n# Default is ''\nIndex metric type (L2, IP, HAMMING, TANIMOTO, COSINE, ) []: \n\nTimeout []:\n","delete user -u (text)\n","milvus_cli > delete user -u zilliz\n","delete alias -a (text) \n","delete collection -c (text) \n","milvus_cli > delete collection -c car\n","delete entities -c (text) -p (text) \n","milvus_cli > delete entities -c car\n\nThe expression to specify entities to be deleted, such as \"film_id in [ 0, 1 ]\": film_id in [ 0, 1 ]\n\nYou are trying to delete the entities of collection. This action cannot be undone!\n\nDo you want to continue? [y/N]: y\n","delete partition -c (text) -p (text)\n","milvus_cli > delete partition -c car -p new_partition\n","delete index -c (text) -in (text)\n","milvus_cli > delete index -c car -in indexName\n","show collection -c (text)\n","milvus_cli > show collection -c test_collection_insert\n","show partition -c (text) -p (text)\n","milvus_cli > show partition -c test_collection_insert -p _default\n","show index -c (text) -in (text)\n","milvus_cli > show index -c test_collection -in index_name\n","exit\n","help \n","import -c (text)[-p (text)] \n","milvus_cli > import -c car 'examples/import_csv/vectors.csv'\n\nReading csv file... [####################################] 100%\n\nColumn names are ['vector', 'color', 'brand']\n\nProcessed 50001 lines.\n\nInserting ...\n\nInsert successfully.\n-------------------------- ------------------\nTotal insert entities: 50000\nTotal collection entities: 150000\nMilvus timestamp: 428849214449254403\n-------------------------- ------------------\n","milvus_cli > import -c car 'https://raw.githubusercontent.com/milvus-\nio/milvus_cli/main/examples/import_csv/vectors.csv'\n\nReading file from remote URL.\n\nReading csv file... [####################################] 100%\n\nColumn names are ['vector', 'color', 'brand']\n\nProcessed 50001 lines.\n\nInserting ...\n\nInsert successfully.\n\n-------------------------- ------------------\nTotal insert entities: 50000\nTotal collection entities: 150000\nMilvus timestamp: 428849214449254403\n-------------------------- ------------------\n","list users\n","list collections\n","list indexes -c (text)\n","list partitions -c (text)\n","load -c (text) [-p (text)]\n","query\n","milvus_cli > query\n\nCollection name: car\n\nThe query expression: id in [ 428960801420883491, 428960801420883492,\n428960801420883493 ]\n\nName of partitions that contain entities(split by \",\" if multiple) []:\ndefault\n\nA list of fields to return(split by \",\" if multiple) []: color, brand\n\ntimeout []:\n\nGuarantee 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]:\nGraceful 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]:\n","milvus_cli > query\n\nCollection name: car\n\nThe query expression: id > 428960801420883491\n\nName of partitions that contain entities(split by \",\" if multiple) []:\ndefault\n\nA list of fields to return(split by \",\" if multiple) []: id, color,\nbrand\n\ntimeout []:\n\nGuarantee 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]:\nGraceful 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]:\n","release -c (text) [-p (text)]\n","search\n","milvus_cli > search\n\nCollection name (car, test_collection): car\n\nThe 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\nout headers): examples/import_csv/search_vectors.csv\n\nThe vector field used to search of collection (vector): vector\n\nSearch parameter nprobe's value: 10\n\nThe max number of returned record, also known as topk: 2\n\nThe boolean expression used to filter attribute []: id > 0\n\nThe names of partitions to search (split by \",\" if multiple) ['_default'] []: _default\n\ntimeout []:\n\nGuarantee 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]:\n\n","milvus_cli > search\n\nCollection name (car, test_collection): car\n\nThe 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):\n [[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]]\n\nThe vector field used to search of collection (vector): vector\n\nSearch parameter nprobe's value: 10\n\nThe specified number of decimal places of returned distance [-1]: 5\n\nThe max number of returned record, also known as topk: 2\n\nThe boolean expression used to filter attribute []: id > 0\n\nThe names of partitions to search (split by \",\" if multiple) ['_default'] []: _default\n\ntimeout []:\n\nGuarantee 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]:\n\n","milvus_cli > search\n\nCollection name (car, car2): car\n\nThe 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\n\nThe vector field used to search of collection (vector): vector\n\nThe specified number of decimal places of returned distance [-1]: 5\n\nThe max number of returned record, also known as topk: 2\n\nThe boolean expression used to filter attribute []:\n\nThe names of partitions to search (split by \",\" if multiple) ['_default'] []:\n\ntimeout []:\n\nGuarantee 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]:\n\n","list connections \n","show index_progress -c (text) [-i (text)]\n","show loading_progress -c (text) [-p (text)]\n","version\n","$ milvus_cli --version\nMilvus_CLI v0.4.0\n"],"headingContent":"Milvus_CLI Command Reference","anchorList":[{"label":"Milvus_CLI Command Reference","href":"MilvusCLI-Command-Reference","type":1,"isActive":false},{"label":"clear","href":"clear","type":2,"isActive":false},{"label":"connect","href":"connect","type":2,"isActive":false},{"label":"create Database","href":"create-Database","type":2,"isActive":false},{"label":"use Database","href":"use-Database","type":2,"isActive":false},{"label":"list Databases","href":"list-Databases","type":2,"isActive":false},{"label":"delete Database","href":"delete-Database","type":2,"isActive":false},{"label":"create user","href":"create-user","type":2,"isActive":false},{"label":"create alias","href":"create-alias","type":2,"isActive":false},{"label":"create collection","href":"create-collection","type":2,"isActive":false},{"label":"create partition","href":"create-partition","type":2,"isActive":false},{"label":"create index","href":"create-index","type":2,"isActive":false},{"label":"delete user","href":"delete-user","type":2,"isActive":false},{"label":"delete alias","href":"delete-alias","type":2,"isActive":false},{"label":"delete collection","href":"delete-collection","type":2,"isActive":false},{"label":"delete entities","href":"delete-entities","type":2,"isActive":false},{"label":"delete partition","href":"delete-partition","type":2,"isActive":false},{"label":"delete index","href":"delete-index","type":2,"isActive":false},{"label":"show collection","href":"show-collection","type":2,"isActive":false},{"label":"show partition","href":"show-partition","type":2,"isActive":false},{"label":"show index","href":"show-index","type":2,"isActive":false},{"label":"exit","href":"exit","type":2,"isActive":false},{"label":"help","href":"help","type":2,"isActive":false},{"label":"import","href":"import","type":2,"isActive":false},{"label":"list users","href":"list-users","type":2,"isActive":false},{"label":"list collections","href":"list-collections","type":2,"isActive":false},{"label":"list indexes","href":"list-indexes","type":2,"isActive":false},{"label":"list partitions","href":"list-partitions","type":2,"isActive":false},{"label":"load","href":"load","type":2,"isActive":false},{"label":"query","href":"query","type":2,"isActive":false},{"label":"release","href":"release","type":2,"isActive":false},{"label":"search","href":"search","type":2,"isActive":false},{"label":"list connection","href":"list-connection","type":2,"isActive":false},{"label":"show index_progress","href":"show-indexprogress","type":2,"isActive":false},{"label":"show loading_progress","href":"show-loadingprogress","type":2,"isActive":false},{"label":"version","href":"version","type":2,"isActive":false}]} \ No newline at end of file +{"codeList":["clear\n","connect [-uri (text)] [-t (text)]\n","milvus_cli > connect -uri http://127.0.0.1:19530\n","create database -db (text)\n","milvus_cli > create database -db testdb\n","use database -db (text)\n","milvus_cli > use database -db testdb\n","list databases\n","milvus_cli > list databases\n","delete database -db (text)\n","milvus_cli > delete database -db testdb\n","create user -u (text) -p (text)\n","milvus_cli > create user -u zilliz -p zilliz\n","create role -r (text)\n","milvus_cli > create role -r role1\n","create alias -c (text) -a (text) [-A]\n","milvus_cli > create alias -c car -a carAlias1\n","milvus_cli > create alias -c car2 -A -a carAlias1\n","create collection -c (text) -f (text) -p (text) [-a] [-d (text)]\n","## For array field: --schema-field support :::(:if Varchar)\n\nmilvus_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'\n","create partition -c (text) -p (text) [-d (text)]\n","milvus_cli > create partition -c car -p new_partition -d test_add_partition\n","create index\n","milvus_cli > create index\n\nCollection name (car, car2): car2\n\nThe name of the field to create an index for (vector): vector\n\nIndex name: vectorIndex\n\n# Default is ''\nIndex 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\n\n# Default is ''\nIndex metric type (L2, IP, HAMMING, TANIMOTO, COSINE, ) []:\n\nTimeout []:\n","delete user -u (text)\n","milvus_cli > delete user -u zilliz\n","delete role -r (text)\n","milvus_cli > delete role -r role1\n","delete alias -a (text)\n","delete collection -c (text)\n","milvus_cli > delete collection -c car\n","delete entities -c (text) -p (text)\n","milvus_cli > delete entities -c car\n\nThe expression to specify entities to be deleted, such as \"film_id in [ 0, 1 ]\": film_id in [ 0, 1 ]\n\nYou are trying to delete the entities of collection. This action cannot be undone!\n\nDo you want to continue? [y/N]: y\n","delete partition -c (text) -p (text)\n","milvus_cli > delete partition -c car -p new_partition\n","delete index -c (text) -in (text)\n","milvus_cli > delete index -c car -in indexName\n","grant role -r role1 -u user1\n","grant privilege\n","grant role -r role1 -u user1\n","revoke privilege\n","show collection -c (text)\n","milvus_cli > show collection -c test_collection_insert\n","show partition -c (text) -p (text)\n","milvus_cli > show partition -c test_collection_insert -p _default\n","show index -c (text) -in (text)\n","milvus_cli > show index -c test_collection -in index_name\n","exit\n","help \n","import -c (text)[-p (text)] \n","milvus_cli > import -c car 'examples/import_csv/vectors.csv'\n\nReading csv file... [####################################] 100%\n\nColumn names are ['vector', 'color', 'brand']\n\nProcessed 50001 lines.\n\nInserting ...\n\nInsert successfully.\n-------------------------- ------------------\nTotal insert entities: 50000\nTotal collection entities: 150000\nMilvus timestamp: 428849214449254403\n-------------------------- ------------------\n","milvus_cli > import -c car 'https://raw.githubusercontent.com/milvus-\nio/milvus_cli/main/examples/import_csv/vectors.csv'\n\nReading file from remote URL.\n\nReading csv file... [####################################] 100%\n\nColumn names are ['vector', 'color', 'brand']\n\nProcessed 50001 lines.\n\nInserting ...\n\nInsert successfully.\n\n-------------------------- ------------------\nTotal insert entities: 50000\nTotal collection entities: 150000\nMilvus timestamp: 428849214449254403\n-------------------------- ------------------\n","list users\n","list roles\n","milvus_cli > list roles\n","milvus_cli > list grants -r role1 -o object1 -t Collection\n","list collections\n","list indexes -c (text)\n","list partitions -c (text)\n","load -c (text) [-p (text)]\n","query\n","milvus_cli > query\n\nCollection name: car\n\nThe query expression: id in [ 428960801420883491, 428960801420883492,\n428960801420883493 ]\n\nName of partitions that contain entities(split by \",\" if multiple) []:\ndefault\n\nA list of fields to return(split by \",\" if multiple) []: color, brand\n\ntimeout []:\n\nGuarantee 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]:\nGraceful 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]:\n","milvus_cli > query\n\nCollection name: car\n\nThe query expression: id > 428960801420883491\n\nName of partitions that contain entities(split by \",\" if multiple) []:\ndefault\n\nA list of fields to return(split by \",\" if multiple) []: id, color,\nbrand\n\ntimeout []:\n\nGuarantee 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]:\nGraceful 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]:\n","release -c (text) [-p (text)]\n","search\n","milvus_cli > search\n\nCollection name (car, test_collection): car\n\nThe 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\nout headers): examples/import_csv/search_vectors.csv\n\nThe vector field used to search of collection (vector): vector\n\nSearch parameter nprobe's value: 10\n\nThe max number of returned record, also known as topk: 2\n\nThe boolean expression used to filter attribute []: id > 0\n\nThe names of partitions to search (split by \",\" if multiple) ['_default'] []: _default\n\ntimeout []:\n\nGuarantee 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]:\n\n","milvus_cli > search\n\nCollection name (car, test_collection): car\n\nThe 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):\n [[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]]\n\nThe vector field used to search of collection (vector): vector\n\nSearch parameter nprobe's value: 10\n\nThe specified number of decimal places of returned distance [-1]: 5\n\nThe max number of returned record, also known as topk: 2\n\nThe boolean expression used to filter attribute []: id > 0\n\nThe names of partitions to search (split by \",\" if multiple) ['_default'] []: _default\n\ntimeout []:\n\nGuarantee 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]:\n\n","milvus_cli > search\n\nCollection name (car, car2): car\n\nThe 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\n\nThe vector field used to search of collection (vector): vector\n\nThe specified number of decimal places of returned distance [-1]: 5\n\nThe max number of returned record, also known as topk: 2\n\nThe boolean expression used to filter attribute []:\n\nThe names of partitions to search (split by \",\" if multiple) ['_default'] []:\n\ntimeout []:\n\nGuarantee 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]:\n\n","list connections\n","show index_progress -c (text) [-i (text)]\n","show loading_progress -c (text) [-p (text)]\n","version\n","$ milvus_cli --version\nMilvus_CLI v0.4.0\n"],"headingContent":"Milvus_CLI Command Reference","anchorList":[{"label":"Milvus_CLI Command Reference","href":"MilvusCLI-Command-Reference","type":1,"isActive":false},{"label":"clear","href":"clear","type":2,"isActive":false},{"label":"connect","href":"connect","type":2,"isActive":false},{"label":"create Database","href":"create-Database","type":2,"isActive":false},{"label":"use Database","href":"use-Database","type":2,"isActive":false},{"label":"list Databases","href":"list-Databases","type":2,"isActive":false},{"label":"delete Database","href":"delete-Database","type":2,"isActive":false},{"label":"create user","href":"create-user","type":2,"isActive":false},{"label":"create role","href":"create-role","type":2,"isActive":false},{"label":"create alias","href":"create-alias","type":2,"isActive":false},{"label":"create collection","href":"create-collection","type":2,"isActive":false},{"label":"create partition","href":"create-partition","type":2,"isActive":false},{"label":"create index","href":"create-index","type":2,"isActive":false},{"label":"delete user","href":"delete-user","type":2,"isActive":false},{"label":"delete role","href":"delete-role","type":2,"isActive":false},{"label":"delete alias","href":"delete-alias","type":2,"isActive":false},{"label":"delete collection","href":"delete-collection","type":2,"isActive":false},{"label":"delete entities","href":"delete-entities","type":2,"isActive":false},{"label":"delete partition","href":"delete-partition","type":2,"isActive":false},{"label":"delete index","href":"delete-index","type":2,"isActive":false},{"label":"grant role","href":"grant-role","type":2,"isActive":false},{"label":"grant privilege","href":"grant-privilege","type":2,"isActive":false},{"label":"revoke role","href":"revoke-role","type":2,"isActive":false},{"label":"revoke privilege","href":"revoke-privilege","type":2,"isActive":false},{"label":"show collection","href":"show-collection","type":2,"isActive":false},{"label":"show partition","href":"show-partition","type":2,"isActive":false},{"label":"show index","href":"show-index","type":2,"isActive":false},{"label":"exit","href":"exit","type":2,"isActive":false},{"label":"help","href":"help","type":2,"isActive":false},{"label":"import","href":"import","type":2,"isActive":false},{"label":"list users","href":"list-users","type":2,"isActive":false},{"label":"List roles","href":"List-roles","type":2,"isActive":false},{"label":"List grants","href":"List-grants","type":2,"isActive":false},{"label":"list collections","href":"list-collections","type":2,"isActive":false},{"label":"list indexes","href":"list-indexes","type":2,"isActive":false},{"label":"list partitions","href":"list-partitions","type":2,"isActive":false},{"label":"load","href":"load","type":2,"isActive":false},{"label":"query","href":"query","type":2,"isActive":false},{"label":"release","href":"release","type":2,"isActive":false},{"label":"search","href":"search","type":2,"isActive":false},{"label":"list connection","href":"list-connection","type":2,"isActive":false},{"label":"show index_progress","href":"show-indexprogress","type":2,"isActive":false},{"label":"show loading_progress","href":"show-loadingprogress","type":2,"isActive":false},{"label":"version","href":"version","type":2,"isActive":false}]} \ No newline at end of file diff --git a/localization/v2.5.x/site/en/userGuide/tools/cli_commands.md b/localization/v2.5.x/site/en/userGuide/tools/cli_commands.md index 1ab8b33f1..0bda658c6 100644 --- a/localization/v2.5.x/site/en/userGuide/tools/cli_commands.md +++ b/localization/v2.5.x/site/en/userGuide/tools/cli_commands.md @@ -79,7 +79,7 @@ title: Milvus_CLI Command Reference

Example

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

 
create Database
Create Database in Milvus

 
Syntax

-
create database -db (text) 
+
create database -db (text)
 

 
Options

@@ -109,7 +109,7 @@ title: Milvus_CLI Command Reference
 

 
–helpn/aDisplays help for using the command.

 
 

-
Examples
Example 1
The following example create the database testdb  in milvus.

+
Examples
Example 1
The following example create the database testdb in milvus.

 
milvus_cli > create database -db testdb
 

 
use Database
Use Database in Milvus

 
Syntax

-
use database -db (text) 
+
use database -db (text)
 

 
Options

@@ -140,7 +140,7 @@ title: Milvus_CLI Command Reference
 

 
–helpn/aDisplays help for using the command.

 
 

-
Examples
Example 1
The following example use the database testdb  in milvus.

+
Examples
Example 1
The following example use the database testdb in milvus.

 
milvus_cli > use database -db testdb
 

 
list Databases
List Databases in Milvus

 
Syntax

-
list databases 
+
list databases
 

 
Examples
Example 1
The following example list the databases in milvus.

 
milvus_cli > list databases
@@ -182,7 +182,7 @@ title: Milvus_CLI Command Reference
       
     
Delete Database in Milvus

 
Syntax

-
delete database -db (text) 
+
delete database -db (text)
 

 
Options

@@ -193,7 +193,7 @@ title: Milvus_CLI Command Reference
 

 
–helpn/aDisplays help for using the command.

 
 

-
Examples
Example 1
The following example delete the database testdb  in milvus.

+
Examples
Example 1
The following example delete the database testdb in milvus.

 
milvus_cli > delete database -db testdb
 

 
create user

+
create role
Create role in Milvus

+
Syntax

+
create role -r (text)
+

+
Options

+
+
+
+
+
+
+
+
OptionFull nameDescription
-r–roleNameThe role name of milvus role.
–helpn/aDisplays help for using the command.

+
Examples
Example 1
The following example create the role role1 in milvus.

+
milvus_cli > create role -r role1
+

 
create alias
Specifies unique aliases for a collection.

 
A collection can have multiple aliases. However, an alias corresponds to a maximum of one collection.

 
Syntax

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

 
Options

 
@@ -385,10 +416,10 @@ The name of the field to create an index for (
 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 []:
 
@@ -421,6 +452,37 @@ Timeout []:
 

 
Example
milvus_cli > delete user -u zilliz
 

+
delete role
Delete role in Milvus

+
Syntax

+
delete role -r (text)
+

+
Options

+
+
+
+
+
+
+
+
OptionFull nameDescription
-r–roleNameThe role name of milvus role.
–helpn/aDisplays help for using the command.

+
Examples
The following example delete the role role1 in milvus.

+
milvus_cli > delete role -r role1
+

 
delete alias
Deletes an alias.

 
Syntax

-
delete alias -a (text) 
+
delete alias -a (text)
 

 
Options

 
@@ -468,7 +530,7 @@ Timeout []:
       
Deletes a collection.
Syntax

-
delete collection -c (text) 
+
delete collection -c (text)
 

 
Options

 

     
 

@@ -500,7 +562,7 @@ Timeout []:
       
     
Deletes entities.

 
Syntax

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

 
Options

 

@@ -575,7 +637,7 @@ Timeout []:
 
Syntax

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

-
Options

+
Options

 

@@ -586,9 +648,129 @@ Timeout []:
 

 
 
OptionFull nameDescription
–helpn/aDisplays help for using the command.

 
 

-
Example

+
Example

 
milvus_cli > delete index -c car -in indexName
 

+
grant role
Grant role to user

+
Syntax

+
Options

+
+
+
+
+
+
+
+
+
+
OptionFull nameDescription
-r–roleNameThe role name of milvus role.
-u–usernameThe username of milvus user.
–helpn/aDisplays help for using the command.

+
Example

+
grant role -r role1 -u user1
+

+
grant privilege
Assigns a privilege to a role.

+
Syntax

+
Options

+
+
+
+
+
+
+
+
OptionFull nameDescription
–helpn/aDisplays help for using the command.

+
Example

+
grant privilege
+

+
revoke role
Revokes the role assigned to a user.

+
Syntax

+
Options

+
+
+
+
+
+
+
+
+
+
OptionFull nameDescription
-r–roleNameThe role name of milvus role.
-u–usernameThe username of milvus user.
–helpn/aDisplays help for using the command.

+
Example

+
grant role -r role1 -u user1
+

+
revoke privilege
Revokes a privilege already assigned to a role.

+
Syntax

+
Options

+
+
+
+
+
+
+
+
OptionFull nameDescription
–helpn/aDisplays help for using the command.

+
Example

+
revoke privilege
+

 
show collection

 
Options
| Option | Full name | Description |
 | --help | n/a | Displays help for using the command. |

+
List roles
List roles in Milvus

+
Syntax

+
list roles
+

+
Options

+
+
+
+
+
+
+
OptionFull nameDescription
–helpn/aDisplays help for using the command.

+
Examples
milvus_cli > list roles
+

+
List grants
List grants in Milvus

+
Options

+
+
+
+
+
+
+
+
+
+
OptionFull nameDescription
-r–roleNameThe role name of milvus role.
-o–objectNameThe object name of milvus object.
-t–objectTypeGlobal, Collection or User.
–helpn/aDisplays help for using the command.

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

 
list collections
List connections.

 
Syntax

-
list connections 
+
list connections
 

 
Options

 
diff --git a/localization/v2.5.x/site/en/userGuide/tools/cli_overview.md b/localization/v2.5.x/site/en/userGuide/tools/cli_overview.md
index 373c0e1c5..78cf47a4d 100644
--- a/localization/v2.5.x/site/en/userGuide/tools/cli_overview.md
+++ b/localization/v2.5.x/site/en/userGuide/tools/cli_overview.md
@@ -56,6 +56,7 @@ title: Milvus Command-Line Interface
 
+
2.2.x2.2.x0.4.0

 
2.3.x2.3.x0.4.2

 
2.4.x2.4.x1.0.0
2.4.x2.4.x1.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.

@@ -74,5 +75,5 @@ title: Milvus Command-Line Interface
           d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"
         >
       
-    
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.