MilvusClient.html 147 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Fri Apr 19 15:06:25 CST 2024 -->
  6. <title>MilvusClient</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2024-04-19">
  9. <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
  11. <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
  12. <script type="text/javascript" src="../../../script.js"></script>
  13. <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
  14. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  15. <!--[if IE]>
  16. <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  17. <![endif]-->
  18. <script type="text/javascript" src="../../../jquery/jquery-3.6.0.min.js"></script>
  19. <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
  20. </head>
  21. <body>
  22. <script type="text/javascript"><!--
  23. try {
  24. if (location.href.indexOf('is-external=true') == -1) {
  25. parent.document.title="MilvusClient";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":18,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":6,"i38":6,"i39":6,"i40":6,"i41":6,"i42":6,"i43":6,"i44":6,"i45":6,"i46":6,"i47":6,"i48":6,"i49":6,"i50":6,"i51":6,"i52":6,"i53":6,"i54":6,"i55":6,"i56":6,"i57":6,"i58":6,"i59":6,"i60":6,"i61":6,"i62":6,"i63":6,"i64":6,"i65":6,"i66":6,"i67":6,"i68":6,"i69":6,"i70":6,"i71":6,"i72":6,"i73":6,"i74":6,"i75":6,"i76":6,"i77":6,"i78":6,"i79":6,"i80":6,"i81":6,"i82":6,"i83":6,"i84":6,"i85":6,"i86":6,"i87":6,"i88":6,"i89":38,"i90":6,"i91":38,"i92":6};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]};
  33. var altColor = "altColor";
  34. var rowColor = "rowColor";
  35. var tableTab = "tableTab";
  36. var activeTableTab = "activeTableTab";
  37. var pathtoroot = "../../../";
  38. var useModuleDirectories = true;
  39. loadScripts(document, 'script');</script>
  40. <noscript>
  41. <div>JavaScript is disabled on your browser.</div>
  42. </noscript>
  43. <header role="banner">
  44. <nav role="navigation">
  45. <div class="fixedNav">
  46. <!-- ========= START OF TOP NAVBAR ======= -->
  47. <div class="topNav"><a id="navbar.top">
  48. <!-- -->
  49. </a>
  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  51. <a id="navbar.top.firstrow">
  52. <!-- -->
  53. </a>
  54. <ul class="navList" title="Navigation">
  55. <li><a href="../../../index.html">Overview</a></li>
  56. <li><a href="package-summary.html">Package</a></li>
  57. <li class="navBarCell1Rev">Class</li>
  58. <li><a href="package-tree.html">Tree</a></li>
  59. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  60. <li><a href="../../../index-files/index-1.html">Index</a></li>
  61. <li><a href="../../../help-doc.html">Help</a></li>
  62. </ul>
  63. </div>
  64. <div class="subNav">
  65. <ul class="navList" id="allclasses_navbar_top">
  66. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  67. </ul>
  68. <ul class="navListSearch">
  69. <li><label for="search">SEARCH:</label>
  70. <input type="text" id="search" value="search" disabled="disabled">
  71. <input type="reset" id="reset" value="reset" disabled="disabled">
  72. </li>
  73. </ul>
  74. <div>
  75. <script type="text/javascript"><!--
  76. allClassesLink = document.getElementById("allclasses_navbar_top");
  77. if(window==top) {
  78. allClassesLink.style.display = "block";
  79. }
  80. else {
  81. allClassesLink.style.display = "none";
  82. }
  83. //-->
  84. </script>
  85. <noscript>
  86. <div>JavaScript is disabled on your browser.</div>
  87. </noscript>
  88. </div>
  89. <div>
  90. <ul class="subNavList">
  91. <li>Summary:&nbsp;</li>
  92. <li>Nested&nbsp;|&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li>Constr&nbsp;|&nbsp;</li>
  95. <li><a href="#method.summary">Method</a></li>
  96. </ul>
  97. <ul class="subNavList">
  98. <li>Detail:&nbsp;</li>
  99. <li>Field&nbsp;|&nbsp;</li>
  100. <li>Constr&nbsp;|&nbsp;</li>
  101. <li><a href="#method.detail">Method</a></li>
  102. </ul>
  103. </div>
  104. <a id="skip.navbar.top">
  105. <!-- -->
  106. </a></div>
  107. <!-- ========= END OF TOP NAVBAR ========= -->
  108. </div>
  109. <div class="navPadding">&nbsp;</div>
  110. <script type="text/javascript"><!--
  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  112. //-->
  113. </script>
  114. </nav>
  115. </header>
  116. <!-- ======== START OF CLASS DATA ======== -->
  117. <main role="main">
  118. <div class="header">
  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.client</a></div>
  120. <h2 title="Interface MilvusClient" class="title">Interface MilvusClient</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <div class="description">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <dl>
  127. <dt>All Known Implementing Classes:</dt>
  128. <dd><code><a href="AbstractMilvusGrpcClient.html" title="class in io.milvus.client">AbstractMilvusGrpcClient</a></code>, <code><a href="MilvusMultiServiceClient.html" title="class in io.milvus.client">MilvusMultiServiceClient</a></code>, <code><a href="MilvusServiceClient.html" title="class in io.milvus.client">MilvusServiceClient</a></code></dd>
  129. </dl>
  130. <hr>
  131. <pre>public interface <span class="typeNameLabel">MilvusClient</span></pre>
  132. <div class="block">The Milvus Client Interface</div>
  133. </li>
  134. </ul>
  135. </div>
  136. <div class="summary">
  137. <ul class="blockList">
  138. <li class="blockList">
  139. <!-- ========== METHOD SUMMARY =========== -->
  140. <section>
  141. <ul class="blockList">
  142. <li class="blockList"><a id="method.summary">
  143. <!-- -->
  144. </a>
  145. <h3>Method Summary</h3>
  146. <table class="memberSummary">
  147. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  148. <tr>
  149. <th class="colFirst" scope="col">Modifier and Type</th>
  150. <th class="colSecond" scope="col">Method</th>
  151. <th class="colLast" scope="col">Description</th>
  152. </tr>
  153. <tr id="i0" class="altColor">
  154. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  155. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addUserToRole(io.milvus.param.role.AddUserToRoleParam)">addUserToRole</a></span>&#8203;(<a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a>&nbsp;requestParam)</code></th>
  156. <td class="colLast">
  157. <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
  158. </td>
  159. </tr>
  160. <tr id="i1" class="rowColor">
  161. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  162. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></span>&#8203;(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a>&nbsp;requestParam)</code></th>
  163. <td class="colLast">
  164. <div class="block">Alters alias from a collection to another.</div>
  165. </td>
  166. </tr>
  167. <tr id="i2" class="altColor">
  168. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  169. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterCollection(io.milvus.param.collection.AlterCollectionParam)">alterCollection</a></span>&#8203;(<a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a>&nbsp;requestParam)</code></th>
  170. <td class="colLast">
  171. <div class="block">Alter collection.</div>
  172. </td>
  173. </tr>
  174. <tr id="i3" class="rowColor">
  175. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ImportResponse&gt;</code></td>
  176. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">bulkInsert</a></span>&#8203;(<a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a>&nbsp;requestParam)</code></th>
  177. <td class="colLast">
  178. <div class="block">Import data from external files, currently support JSON format</div>
  179. </td>
  180. </tr>
  181. <tr id="i4" class="altColor">
  182. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.CheckHealthResponse&gt;</code></td>
  183. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkHealth()">checkHealth</a></span>()</code></th>
  184. <td class="colLast">
  185. <div class="block">Check server health</div>
  186. </td>
  187. </tr>
  188. <tr id="i5" class="rowColor">
  189. <td class="colFirst"><code>default void</code></td>
  190. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
  191. <td class="colLast">
  192. <div class="block">Disconnects from a Milvus server with timeout of 1 minute</div>
  193. </td>
  194. </tr>
  195. <tr id="i6" class="altColor">
  196. <td class="colFirst"><code>void</code></td>
  197. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(long)">close</a></span>&#8203;(long&nbsp;maxWaitSeconds)</code></th>
  198. <td class="colLast">
  199. <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
  200. </td>
  201. </tr>
  202. <tr id="i7" class="rowColor">
  203. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  204. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></span>&#8203;(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a>&nbsp;requestParam)</code></th>
  205. <td class="colLast">
  206. <div class="block">Creates an alias for a collection.</div>
  207. </td>
  208. </tr>
  209. <tr id="i8" class="altColor">
  210. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  211. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></span>&#8203;(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;requestParam)</code></th>
  212. <td class="colLast">
  213. <div class="block">Creates a collection in Milvus.</div>
  214. </td>
  215. </tr>
  216. <tr id="i9" class="rowColor">
  217. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  218. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">createCollection</a></span>&#8203;(<a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a>&nbsp;requestParam)</code></th>
  219. <td class="colLast">
  220. <div class="block">Creates a collection in Milvus.</div>
  221. </td>
  222. </tr>
  223. <tr id="i10" class="altColor">
  224. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  225. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></span>&#8203;(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a>&nbsp;requestParam)</code></th>
  226. <td class="colLast">
  227. <div class="block">Create credential using the given user and password.</div>
  228. </td>
  229. </tr>
  230. <tr id="i11" class="rowColor">
  231. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  232. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createDatabase(io.milvus.param.collection.CreateDatabaseParam)">createDatabase</a></span>&#8203;(<a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a>&nbsp;requestParam)</code></th>
  233. <td class="colLast">
  234. <div class="block">Creates a database in Milvus.</div>
  235. </td>
  236. </tr>
  237. <tr id="i12" class="altColor">
  238. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  239. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></span>&#8203;(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a>&nbsp;requestParam)</code></th>
  240. <td class="colLast">
  241. <div class="block">Creates an index on a vector field in the specified collection.</div>
  242. </td>
  243. </tr>
  244. <tr id="i13" class="rowColor">
  245. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  246. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></span>&#8203;(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a>&nbsp;requestParam)</code></th>
  247. <td class="colLast">
  248. <div class="block">Creates a partition in the specified collection.</div>
  249. </td>
  250. </tr>
  251. <tr id="i14" class="altColor">
  252. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  253. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">createResourceGroup</a></span>&#8203;(<a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a>&nbsp;requestParam)</code></th>
  254. <td class="colLast">
  255. <div class="block">Create a resource group.</div>
  256. </td>
  257. </tr>
  258. <tr id="i15" class="rowColor">
  259. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  260. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createRole(io.milvus.param.role.CreateRoleParam)">createRole</a></span>&#8203;(<a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a>&nbsp;requestParam)</code></th>
  261. <td class="colLast">
  262. <div class="block">It will success if the role isn't existed, otherwise fail.</div>
  263. </td>
  264. </tr>
  265. <tr id="i16" class="altColor">
  266. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;</code></td>
  267. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.dml.DeleteParam)">delete</a></span>&#8203;(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a>&nbsp;requestParam)</code></th>
  268. <td class="colLast">
  269. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
  270. </td>
  271. </tr>
  272. <tr id="i17" class="rowColor">
  273. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>&gt;</code></td>
  274. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">delete</a></span>&#8203;(<a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a>&nbsp;requestParam)</code></th>
  275. <td class="colLast">
  276. <div class="block">Deletes entity(s) based on the value of primary key.</div>
  277. </td>
  278. </tr>
  279. <tr id="i18" class="altColor">
  280. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  281. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></span>&#8203;(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a>&nbsp;requestParam)</code></th>
  282. <td class="colLast">
  283. <div class="block">Delete credential corresponding to the user.</div>
  284. </td>
  285. </tr>
  286. <tr id="i19" class="rowColor">
  287. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeCollectionResponse&gt;</code></td>
  288. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></span>&#8203;(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a>&nbsp;requestParam)</code></th>
  289. <td class="colLast">
  290. <div class="block">Shows the details of a collection, e.g.</div>
  291. </td>
  292. </tr>
  293. <tr id="i20" class="altColor">
  294. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeIndexResponse&gt;</code></td>
  295. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></span>&#8203;(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a>&nbsp;requestParam)</code></th>
  296. <td class="colLast">
  297. <div class="block">Shows the information of the specified index.</div>
  298. </td>
  299. </tr>
  300. <tr id="i21" class="rowColor">
  301. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeResourceGroupResponse&gt;</code></td>
  302. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">describeResourceGroup</a></span>&#8203;(<a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a>&nbsp;requestParam)</code></th>
  303. <td class="colLast">
  304. <div class="block">Describe a resource group.</div>
  305. </td>
  306. </tr>
  307. <tr id="i22" class="altColor">
  308. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  309. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></span>&#8203;(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a>&nbsp;requestParam)</code></th>
  310. <td class="colLast">
  311. <div class="block">Drops an alias for the specified collection.</div>
  312. </td>
  313. </tr>
  314. <tr id="i23" class="rowColor">
  315. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  316. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></span>&#8203;(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a>&nbsp;requestParam)</code></th>
  317. <td class="colLast">
  318. <div class="block">Drops a collection.</div>
  319. </td>
  320. </tr>
  321. <tr id="i24" class="altColor">
  322. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  323. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropDatabase(io.milvus.param.collection.DropDatabaseParam)">dropDatabase</a></span>&#8203;(<a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a>&nbsp;requestParam)</code></th>
  324. <td class="colLast">
  325. <div class="block">Drops a database.</div>
  326. </td>
  327. </tr>
  328. <tr id="i25" class="rowColor">
  329. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  330. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></span>&#8203;(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a>&nbsp;requestParam)</code></th>
  331. <td class="colLast">
  332. <div class="block">Drops the index on a vector field in the specified collection.</div>
  333. </td>
  334. </tr>
  335. <tr id="i26" class="altColor">
  336. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  337. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></span>&#8203;(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a>&nbsp;requestParam)</code></th>
  338. <td class="colLast">
  339. <div class="block">Drops a partition.</div>
  340. </td>
  341. </tr>
  342. <tr id="i27" class="rowColor">
  343. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  344. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">dropResourceGroup</a></span>&#8203;(<a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a>&nbsp;requestParam)</code></th>
  345. <td class="colLast">
  346. <div class="block">Drop a resource group.</div>
  347. </td>
  348. </tr>
  349. <tr id="i28" class="altColor">
  350. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  351. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropRole(io.milvus.param.role.DropRoleParam)">dropRole</a></span>&#8203;(<a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a>&nbsp;requestParam)</code></th>
  352. <td class="colLast">
  353. <div class="block">It will success if the role is existed, otherwise fail.</div>
  354. </td>
  355. </tr>
  356. <tr id="i29" class="rowColor">
  357. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushResponse&gt;</code></td>
  358. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush(io.milvus.param.collection.FlushParam)">flush</a></span>&#8203;(<a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a>&nbsp;requestParam)</code></th>
  359. <td class="colLast">
  360. <div class="block">Flushes inserted data in buffer into storage.</div>
  361. </td>
  362. </tr>
  363. <tr id="i30" class="altColor">
  364. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushAllResponse&gt;</code></td>
  365. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushAll(boolean,long,long)">flushAll</a></span>&#8203;(boolean&nbsp;syncFlushAll,
  366. long&nbsp;syncFlushAllWaitingInterval,
  367. long&nbsp;syncFlushAllTimeout)</code></th>
  368. <td class="colLast">
  369. <div class="block">Flush all collections.</div>
  370. </td>
  371. </tr>
  372. <tr id="i31" class="rowColor">
  373. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>&gt;</code></td>
  374. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(io.milvus.param.highlevel.dml.GetIdsParam)">get</a></span>&#8203;(<a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a>&nbsp;requestParam)</code></th>
  375. <td class="colLast">
  376. <div class="block">Get entity(s) based on the value of primary key.</div>
  377. </td>
  378. </tr>
  379. <tr id="i32" class="altColor">
  380. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetImportStateResponse&gt;</code></td>
  381. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">getBulkInsertState</a></span>&#8203;(<a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a>&nbsp;requestParam)</code></th>
  382. <td class="colLast">
  383. <div class="block">Get state of bulk insert task</div>
  384. </td>
  385. </tr>
  386. <tr id="i33" class="rowColor">
  387. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCollectionStatisticsResponse&gt;</code></td>
  388. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></span>&#8203;(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a>&nbsp;requestParam)</code></th>
  389. <td class="colLast">
  390. <div class="block">Shows the statistics information of a collection.</div>
  391. </td>
  392. </tr>
  393. <tr id="i34" class="altColor">
  394. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionStateResponse&gt;</code></td>
  395. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></span>&#8203;(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a>&nbsp;requestParam)</code></th>
  396. <td class="colLast">
  397. <div class="block">Gets the compaction state by id.</div>
  398. </td>
  399. </tr>
  400. <tr id="i35" class="rowColor">
  401. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionPlansResponse&gt;</code></td>
  402. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></span>&#8203;(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a>&nbsp;requestParam)</code></th>
  403. <td class="colLast">
  404. <div class="block">Gets compaction state with its plan.</div>
  405. </td>
  406. </tr>
  407. <tr id="i36" class="altColor">
  408. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushAllStateResponse&gt;</code></td>
  409. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">getFlushAllState</a></span>&#8203;(<a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a>&nbsp;requestParam)</code></th>
  410. <td class="colLast">
  411. <div class="block">Get flush state of all segments.</div>
  412. </td>
  413. </tr>
  414. <tr id="i37" class="rowColor">
  415. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushStateResponse&gt;</code></td>
  416. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></span>&#8203;(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a>&nbsp;requestParam)</code></th>
  417. <td class="colLast">
  418. <div class="block">Get flush state of specified collection.</div>
  419. </td>
  420. </tr>
  421. <tr id="i38" class="altColor">
  422. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexBuildProgressResponse&gt;</code></td>
  423. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></span>&#8203;(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a>&nbsp;requestParam)</code></th>
  424. <td class="colLast">
  425. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
  426. </td>
  427. </tr>
  428. <tr id="i39" class="rowColor">
  429. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexStateResponse&gt;</code></td>
  430. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></span>&#8203;(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a>&nbsp;requestParam)</code></th>
  431. <td class="colLast">
  432. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
  433. </td>
  434. </tr>
  435. <tr id="i40" class="altColor">
  436. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadingProgressResponse&gt;</code></td>
  437. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">getLoadingProgress</a></span>&#8203;(<a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a>&nbsp;requestParam)</code></th>
  438. <td class="colLast">
  439. <div class="block">Get collection loading progress</div>
  440. </td>
  441. </tr>
  442. <tr id="i41" class="rowColor">
  443. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadStateResponse&gt;</code></td>
  444. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLoadState(io.milvus.param.collection.GetLoadStateParam)">getLoadState</a></span>&#8203;(<a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a>&nbsp;requestParam)</code></th>
  445. <td class="colLast">
  446. <div class="block">Get collection loading state</div>
  447. </td>
  448. </tr>
  449. <tr id="i42" class="altColor">
  450. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetMetricsResponse&gt;</code></td>
  451. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></span>&#8203;(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a>&nbsp;requestParam)</code></th>
  452. <td class="colLast">
  453. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
  454. </td>
  455. </tr>
  456. <tr id="i43" class="rowColor">
  457. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPartitionStatisticsResponse&gt;</code></td>
  458. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></span>&#8203;(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a>&nbsp;requestParam)</code></th>
  459. <td class="colLast">
  460. <div class="block">Shows the statistics information of a partition.</div>
  461. </td>
  462. </tr>
  463. <tr id="i44" class="altColor">
  464. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPersistentSegmentInfoResponse&gt;</code></td>
  465. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></span>&#8203;(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a>&nbsp;requestParam)</code></th>
  466. <td class="colLast">
  467. <div class="block">Gets the information of persistent segments from data node, including row count,
  468. persistence state(growing or flushed), etc.</div>
  469. </td>
  470. </tr>
  471. <tr id="i45" class="rowColor">
  472. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetQuerySegmentInfoResponse&gt;</code></td>
  473. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></span>&#8203;(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a>&nbsp;requestParam)</code></th>
  474. <td class="colLast">
  475. <div class="block">Gets the query information of segments in a collection from query node, including row count,
  476. memory usage size, index name, etc.</div>
  477. </td>
  478. </tr>
  479. <tr id="i46" class="altColor">
  480. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetReplicasResponse&gt;</code></td>
  481. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></span>&#8203;(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a>&nbsp;requestParam)</code></th>
  482. <td class="colLast">
  483. <div class="block">Returns the collection's replica information</div>
  484. </td>
  485. </tr>
  486. <tr id="i47" class="rowColor">
  487. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetVersionResponse&gt;</code></td>
  488. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersion()">getVersion</a></span>()</code></th>
  489. <td class="colLast">
  490. <div class="block">Get server version</div>
  491. </td>
  492. </tr>
  493. <tr id="i48" class="altColor">
  494. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  495. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">grantRolePrivilege</a></span>&#8203;(<a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a>&nbsp;requestParam)</code></th>
  496. <td class="colLast">
  497. <div class="block">Grant Role Privilege.</div>
  498. </td>
  499. </tr>
  500. <tr id="i49" class="rowColor">
  501. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;</code></td>
  502. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></span>&#8203;(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a>&nbsp;requestParam)</code></th>
  503. <td class="colLast">
  504. <div class="block">Checks if a collection exists.</div>
  505. </td>
  506. </tr>
  507. <tr id="i50" class="altColor">
  508. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;</code></td>
  509. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></span>&#8203;(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a>&nbsp;requestParam)</code></th>
  510. <td class="colLast">
  511. <div class="block">Checks if a partition exists in the specified collection.</div>
  512. </td>
  513. </tr>
  514. <tr id="i51" class="rowColor">
  515. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;</code></td>
  516. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.dml.InsertParam)">insert</a></span>&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</code></th>
  517. <td class="colLast">
  518. <div class="block">Inserts entities into a specified collection .</div>
  519. </td>
  520. </tr>
  521. <tr id="i52" class="altColor">
  522. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>&gt;</code></td>
  523. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.highlevel.dml.InsertRowsParam)">insert</a></span>&#8203;(<a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a>&nbsp;requestParam)</code></th>
  524. <td class="colLast">
  525. <div class="block">Inserts rows data into a specified collection .</div>
  526. </td>
  527. </tr>
  528. <tr id="i53" class="rowColor">
  529. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;</code></td>
  530. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></span>&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</code></th>
  531. <td class="colLast">
  532. <div class="block">Inserts entities into a specified collection asynchronously.</div>
  533. </td>
  534. </tr>
  535. <tr id="i54" class="altColor">
  536. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListAliasesResponse&gt;</code></td>
  537. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listAliases(io.milvus.param.alias.ListAliasesParam)">listAliases</a></span>&#8203;(<a href="../param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias">ListAliasesParam</a>&nbsp;requestParam)</code></th>
  538. <td class="colLast">
  539. <div class="block">List all alias for a collection.</div>
  540. </td>
  541. </tr>
  542. <tr id="i55" class="rowColor">
  543. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListImportTasksResponse&gt;</code></td>
  544. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">listBulkInsertTasks</a></span>&#8203;(<a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a>&nbsp;requestParam)</code></th>
  545. <td class="colLast">
  546. <div class="block">List bulk insert tasks</div>
  547. </td>
  548. </tr>
  549. <tr id="i56" class="altColor">
  550. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>&gt;</code></td>
  551. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">listCollections</a></span>&#8203;(<a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a>&nbsp;requestParam)</code></th>
  552. <td class="colLast">
  553. <div class="block">Lists all collections</div>
  554. </td>
  555. </tr>
  556. <tr id="i57" class="rowColor">
  557. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListCredUsersResponse&gt;</code></td>
  558. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></span>&#8203;(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a>&nbsp;requestParam)</code></th>
  559. <td class="colLast">
  560. <div class="block">List all user names.</div>
  561. </td>
  562. </tr>
  563. <tr id="i58" class="altColor">
  564. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListDatabasesResponse&gt;</code></td>
  565. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listDatabases()">listDatabases</a></span>()</code></th>
  566. <td class="colLast">
  567. <div class="block">List databases.</div>
  568. </td>
  569. </tr>
  570. <tr id="i59" class="rowColor">
  571. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListResourceGroupsResponse&gt;</code></td>
  572. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">listResourceGroups</a></span>&#8203;(<a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a>&nbsp;requestParam)</code></th>
  573. <td class="colLast">
  574. <div class="block">List resource groups.</div>
  575. </td>
  576. </tr>
  577. <tr id="i60" class="altColor">
  578. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  579. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></span>&#8203;(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a>&nbsp;requestParam)</code></th>
  580. <td class="colLast">
  581. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
  582. </td>
  583. </tr>
  584. <tr id="i61" class="rowColor">
  585. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  586. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></span>&#8203;(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a>&nbsp;requestParam)</code></th>
  587. <td class="colLast">
  588. <div class="block">Loads a collection to memory before search or query.</div>
  589. </td>
  590. </tr>
  591. <tr id="i62" class="altColor">
  592. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  593. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></span>&#8203;(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a>&nbsp;requestParam)</code></th>
  594. <td class="colLast">
  595. <div class="block">Loads a partition into memory.</div>
  596. </td>
  597. </tr>
  598. <tr id="i63" class="rowColor">
  599. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ManualCompactionResponse&gt;</code></td>
  600. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manualCompact(io.milvus.param.control.ManualCompactParam)">manualCompact</a></span>&#8203;(<a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a>&nbsp;requestParam)</code></th>
  601. <td class="colLast">
  602. <div class="block">Performs a manual compaction.</div>
  603. </td>
  604. </tr>
  605. <tr id="i64" class="altColor">
  606. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;</code></td>
  607. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.dml.QueryParam)">query</a></span>&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</code></th>
  608. <td class="colLast">
  609. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
  610. </td>
  611. </tr>
  612. <tr id="i65" class="rowColor">
  613. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>&gt;</code></td>
  614. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.highlevel.dml.QuerySimpleParam)">query</a></span>&#8203;(<a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a>&nbsp;requestParam)</code></th>
  615. <td class="colLast">
  616. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
  617. </td>
  618. </tr>
  619. <tr id="i66" class="altColor">
  620. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&gt;</code></td>
  621. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></span>&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</code></th>
  622. <td class="colLast">
  623. <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.</div>
  624. </td>
  625. </tr>
  626. <tr id="i67" class="rowColor">
  627. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/QueryIterator.html" title="class in io.milvus.orm.iterator">QueryIterator</a>&gt;</code></td>
  628. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryIterator(io.milvus.param.dml.QueryIteratorParam)">queryIterator</a></span>&#8203;(<a href="../param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml">QueryIteratorParam</a>&nbsp;requestParam)</code></th>
  629. <td class="colLast">
  630. <div class="block">Get queryIterator based on scalar field(s) filtered by boolean expression.</div>
  631. </td>
  632. </tr>
  633. <tr id="i68" class="altColor">
  634. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  635. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></span>&#8203;(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a>&nbsp;requestParam)</code></th>
  636. <td class="colLast">
  637. <div class="block">Releases a collection from memory to reduce memory usage.</div>
  638. </td>
  639. </tr>
  640. <tr id="i69" class="rowColor">
  641. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  642. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></span>&#8203;(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a>&nbsp;requestParam)</code></th>
  643. <td class="colLast">
  644. <div class="block">Releases a partition from memory.</div>
  645. </td>
  646. </tr>
  647. <tr id="i70" class="altColor">
  648. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  649. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">removeUserFromRole</a></span>&#8203;(<a href="../param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a>&nbsp;requestParam)</code></th>
  650. <td class="colLast">
  651. <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
  652. </td>
  653. </tr>
  654. <tr id="i71" class="rowColor">
  655. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  656. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameCollection(io.milvus.param.collection.RenameCollectionParam)">renameCollection</a></span>&#8203;(<a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a>&nbsp;requestParam)</code></th>
  657. <td class="colLast">
  658. <div class="block">rename a collection</div>
  659. </td>
  660. </tr>
  661. <tr id="i72" class="altColor">
  662. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  663. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">revokeRolePrivilege</a></span>&#8203;(<a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a>&nbsp;requestParam)</code></th>
  664. <td class="colLast">
  665. <div class="block">Revoke Role Privilege.</div>
  666. </td>
  667. </tr>
  668. <tr id="i73" class="rowColor">
  669. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;</code></td>
  670. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.dml.SearchParam)">search</a></span>&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</code></th>
  671. <td class="colLast">
  672. <div class="block">Conducts ANN search on a vector field.</div>
  673. </td>
  674. </tr>
  675. <tr id="i74" class="altColor">
  676. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>&gt;</code></td>
  677. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.highlevel.dml.SearchSimpleParam)">search</a></span>&#8203;(<a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a>&nbsp;requestParam)</code></th>
  678. <td class="colLast">
  679. <div class="block">Conducts ANN search on a vector field.</div>
  680. </td>
  681. </tr>
  682. <tr id="i75" class="rowColor">
  683. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&gt;</code></td>
  684. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></span>&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</code></th>
  685. <td class="colLast">
  686. <div class="block">Conducts ANN search on a vector field asynchronously.</div>
  687. </td>
  688. </tr>
  689. <tr id="i76" class="altColor">
  690. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/SearchIterator.html" title="class in io.milvus.orm.iterator">SearchIterator</a>&gt;</code></td>
  691. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchIterator(io.milvus.param.dml.SearchIteratorParam)">searchIterator</a></span>&#8203;(<a href="../param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml">SearchIteratorParam</a>&nbsp;requestParam)</code></th>
  692. <td class="colLast">
  693. <div class="block">Get searchIterator based on a vector field.</div>
  694. </td>
  695. </tr>
  696. <tr id="i77" class="rowColor">
  697. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;</code></td>
  698. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">selectGrantForRole</a></span>&#8203;(<a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a>&nbsp;requestParam)</code></th>
  699. <td class="colLast">
  700. <div class="block">List a grant info for the role and the specific object</div>
  701. </td>
  702. </tr>
  703. <tr id="i78" class="altColor">
  704. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;</code></td>
  705. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">selectGrantForRoleAndObject</a></span>&#8203;(<a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a>&nbsp;requestParam)</code></th>
  706. <td class="colLast">
  707. <div class="block">List a grant info for the role</div>
  708. </td>
  709. </tr>
  710. <tr id="i79" class="rowColor">
  711. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectRoleResponse&gt;</code></td>
  712. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectRole(io.milvus.param.role.SelectRoleParam)">selectRole</a></span>&#8203;(<a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a>&nbsp;requestParam)</code></th>
  713. <td class="colLast">
  714. <div class="block">Get all users who are added to the role.</div>
  715. </td>
  716. </tr>
  717. <tr id="i80" class="altColor">
  718. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectUserResponse&gt;</code></td>
  719. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectUser(io.milvus.param.role.SelectUserParam)">selectUser</a></span>&#8203;(<a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a>&nbsp;requestParam)</code></th>
  720. <td class="colLast">
  721. <div class="block">Get all roles the user has.</div>
  722. </td>
  723. </tr>
  724. <tr id="i81" class="rowColor">
  725. <td class="colFirst"><code>void</code></td>
  726. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogLevel(io.milvus.param.LogLevel)">setLogLevel</a></span>&#8203;(<a href="../param/LogLevel.html" title="enum in io.milvus.param">LogLevel</a>&nbsp;level)</code></th>
  727. <td class="colLast">
  728. <div class="block">Set log level in runtime.</div>
  729. </td>
  730. </tr>
  731. <tr id="i82" class="altColor">
  732. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowCollectionsResponse&gt;</code></td>
  733. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></span>&#8203;(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a>&nbsp;requestParam)</code></th>
  734. <td class="colLast">
  735. <div class="block">Lists all collections or gets collection loading status.</div>
  736. </td>
  737. </tr>
  738. <tr id="i83" class="rowColor">
  739. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowPartitionsResponse&gt;</code></td>
  740. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></span>&#8203;(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a>&nbsp;requestParam)</code></th>
  741. <td class="colLast">
  742. <div class="block">Shows all partitions in the specified collection.</div>
  743. </td>
  744. </tr>
  745. <tr id="i84" class="altColor">
  746. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  747. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">transferNode</a></span>&#8203;(<a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a>&nbsp;requestParam)</code></th>
  748. <td class="colLast">
  749. <div class="block">Transfer a query node from source resource group to target resource_group.</div>
  750. </td>
  751. </tr>
  752. <tr id="i85" class="rowColor">
  753. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  754. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">transferReplica</a></span>&#8203;(<a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a>&nbsp;requestParam)</code></th>
  755. <td class="colLast">
  756. <div class="block">Transfer a replica from source resource group to target resource_group.</div>
  757. </td>
  758. </tr>
  759. <tr id="i86" class="altColor">
  760. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;</code></td>
  761. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></span>&#8203;(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a>&nbsp;requestParam)</code></th>
  762. <td class="colLast">
  763. <div class="block">Update credential using the given user and password.</div>
  764. </td>
  765. </tr>
  766. <tr id="i87" class="rowColor">
  767. <td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;</code></td>
  768. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upsert(io.milvus.param.dml.UpsertParam)">upsert</a></span>&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</code></th>
  769. <td class="colLast">
  770. <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
  771. </td>
  772. </tr>
  773. <tr id="i88" class="altColor">
  774. <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;</code></td>
  775. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#upsertAsync(io.milvus.param.dml.UpsertParam)">upsertAsync</a></span>&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</code></th>
  776. <td class="colLast">
  777. <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
  778. </td>
  779. </tr>
  780. <tr id="i89" class="rowColor">
  781. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  782. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetry(int)">withRetry</a></span>&#8203;(int&nbsp;retryTimes)</code></th>
  783. <td class="colLast">
  784. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  785. </td>
  786. </tr>
  787. <tr id="i90" class="altColor">
  788. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  789. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetry(io.milvus.param.RetryParam)">withRetry</a></span>&#8203;(<a href="../param/RetryParam.html" title="class in io.milvus.param">RetryParam</a>&nbsp;retryParam)</code></th>
  790. <td class="colLast">
  791. <div class="block">Sets the parameters for retry.</div>
  792. </td>
  793. </tr>
  794. <tr id="i91" class="rowColor">
  795. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  796. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withRetryInterval(long,java.util.concurrent.TimeUnit)">withRetryInterval</a></span>&#8203;(long&nbsp;interval,
  797. java.util.concurrent.TimeUnit&nbsp;timeUnit)</code></th>
  798. <td class="colLast">
  799. <div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
  800. </td>
  801. </tr>
  802. <tr id="i92" class="altColor">
  803. <td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
  804. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></span>&#8203;(long&nbsp;timeout,
  805. java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</code></th>
  806. <td class="colLast">
  807. <div class="block">Timeout setting for rpc call.</div>
  808. </td>
  809. </tr>
  810. </table>
  811. </li>
  812. </ul>
  813. </section>
  814. </li>
  815. </ul>
  816. </div>
  817. <div class="details">
  818. <ul class="blockList">
  819. <li class="blockList">
  820. <!-- ============ METHOD DETAIL ========== -->
  821. <section>
  822. <ul class="blockList">
  823. <li class="blockList"><a id="method.detail">
  824. <!-- -->
  825. </a>
  826. <h3>Method Detail</h3>
  827. <a id="withTimeout(long,java.util.concurrent.TimeUnit)">
  828. <!-- -->
  829. </a>
  830. <ul class="blockList">
  831. <li class="blockList">
  832. <h4>withTimeout</h4>
  833. <pre class="methodSignature"><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withTimeout&#8203;(long&nbsp;timeout,
  834. java.util.concurrent.TimeUnit&nbsp;timeoutUnit)</pre>
  835. <div class="block">Timeout setting for rpc call.</div>
  836. <dl>
  837. <dt><span class="paramLabel">Parameters:</span></dt>
  838. <dd><code>timeout</code> - set time waiting for a rpc call.</dd>
  839. <dd><code>timeoutUnit</code> - time unit</dd>
  840. </dl>
  841. </li>
  842. </ul>
  843. <a id="withRetry(io.milvus.param.RetryParam)">
  844. <!-- -->
  845. </a>
  846. <ul class="blockList">
  847. <li class="blockList">
  848. <h4>withRetry</h4>
  849. <pre class="methodSignature"><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withRetry&#8203;(<a href="../param/RetryParam.html" title="class in io.milvus.param">RetryParam</a>&nbsp;retryParam)</pre>
  850. <div class="block">Sets the parameters for retry.</div>
  851. <dl>
  852. <dt><span class="paramLabel">Parameters:</span></dt>
  853. <dd><code>retryParam</code> - <a href="../param/RetryParam.html" title="class in io.milvus.param"><code>RetryParam</code></a></dd>
  854. </dl>
  855. </li>
  856. </ul>
  857. <a id="withRetry(int)">
  858. <!-- -->
  859. </a>
  860. <ul class="blockList">
  861. <li class="blockList">
  862. <h4>withRetry</h4>
  863. <pre class="methodSignature">@Deprecated
  864. <a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withRetry&#8203;(int&nbsp;retryTimes)</pre>
  865. <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
  866. <div class="block">Number of retry attempts.</div>
  867. <dl>
  868. <dt><span class="paramLabel">Parameters:</span></dt>
  869. <dd><code>retryTimes</code> - number of retry attempts.</dd>
  870. </dl>
  871. </li>
  872. </ul>
  873. <a id="withRetryInterval(long,java.util.concurrent.TimeUnit)">
  874. <!-- -->
  875. </a>
  876. <ul class="blockList">
  877. <li class="blockList">
  878. <h4>withRetryInterval</h4>
  879. <pre class="methodSignature">@Deprecated
  880. <a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a>&nbsp;withRetryInterval&#8203;(long&nbsp;interval,
  881. java.util.concurrent.TimeUnit&nbsp;timeUnit)</pre>
  882. <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
  883. <div class="block">Time interval between retry attempts. Default value is 500ms.</div>
  884. <dl>
  885. <dt><span class="paramLabel">Parameters:</span></dt>
  886. <dd><code>interval</code> - time interval between retry attempts.</dd>
  887. <dd><code>timeUnit</code> - time unit</dd>
  888. </dl>
  889. </li>
  890. </ul>
  891. <a id="setLogLevel(io.milvus.param.LogLevel)">
  892. <!-- -->
  893. </a>
  894. <ul class="blockList">
  895. <li class="blockList">
  896. <h4>setLogLevel</h4>
  897. <pre class="methodSignature">void&nbsp;setLogLevel&#8203;(<a href="../param/LogLevel.html" title="enum in io.milvus.param">LogLevel</a>&nbsp;level)</pre>
  898. <div class="block">Set log level in runtime.</div>
  899. <dl>
  900. <dt><span class="paramLabel">Parameters:</span></dt>
  901. <dd><code>level</code> - <a href="../param/LogLevel.html" title="enum in io.milvus.param"><code>LogLevel</code></a></dd>
  902. </dl>
  903. </li>
  904. </ul>
  905. <a id="close()">
  906. <!-- -->
  907. </a>
  908. <ul class="blockList">
  909. <li class="blockList">
  910. <h4>close</h4>
  911. <pre class="methodSignature">default&nbsp;void&nbsp;close()</pre>
  912. <div class="block">Disconnects from a Milvus server with timeout of 1 minute</div>
  913. </li>
  914. </ul>
  915. <a id="close(long)">
  916. <!-- -->
  917. </a>
  918. <ul class="blockList">
  919. <li class="blockList">
  920. <h4>close</h4>
  921. <pre class="methodSignature">void&nbsp;close&#8203;(long&nbsp;maxWaitSeconds)
  922. throws java.lang.InterruptedException</pre>
  923. <div class="block">Disconnects from a Milvus server with configurable timeout.</div>
  924. <dl>
  925. <dt><span class="paramLabel">Parameters:</span></dt>
  926. <dd><code>maxWaitSeconds</code> - timeout unit: second</dd>
  927. <dt><span class="throwsLabel">Throws:</span></dt>
  928. <dd><code>java.lang.InterruptedException</code></dd>
  929. </dl>
  930. </li>
  931. </ul>
  932. <a id="hasCollection(io.milvus.param.collection.HasCollectionParam)">
  933. <!-- -->
  934. </a>
  935. <ul class="blockList">
  936. <li class="blockList">
  937. <h4>hasCollection</h4>
  938. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;&nbsp;hasCollection&#8203;(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a>&nbsp;requestParam)</pre>
  939. <div class="block">Checks if a collection exists.</div>
  940. <dl>
  941. <dt><span class="paramLabel">Parameters:</span></dt>
  942. <dd><code>requestParam</code> - <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection"><code>HasCollectionParam</code></a></dd>
  943. <dt><span class="returnLabel">Returns:</span></dt>
  944. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
  945. </dl>
  946. </li>
  947. </ul>
  948. <a id="createDatabase(io.milvus.param.collection.CreateDatabaseParam)">
  949. <!-- -->
  950. </a>
  951. <ul class="blockList">
  952. <li class="blockList">
  953. <h4>createDatabase</h4>
  954. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createDatabase&#8203;(<a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection">CreateDatabaseParam</a>&nbsp;requestParam)</pre>
  955. <div class="block">Creates a database in Milvus.</div>
  956. <dl>
  957. <dt><span class="paramLabel">Parameters:</span></dt>
  958. <dd><code>requestParam</code> - <a href="../param/collection/CreateDatabaseParam.html" title="class in io.milvus.param.collection"><code>CreateDatabaseParam</code></a></dd>
  959. <dt><span class="returnLabel">Returns:</span></dt>
  960. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  961. </dl>
  962. </li>
  963. </ul>
  964. <a id="dropDatabase(io.milvus.param.collection.DropDatabaseParam)">
  965. <!-- -->
  966. </a>
  967. <ul class="blockList">
  968. <li class="blockList">
  969. <h4>dropDatabase</h4>
  970. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropDatabase&#8203;(<a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection">DropDatabaseParam</a>&nbsp;requestParam)</pre>
  971. <div class="block">Drops a database. Note that this method drops all data in the database.</div>
  972. <dl>
  973. <dt><span class="paramLabel">Parameters:</span></dt>
  974. <dd><code>requestParam</code> - <a href="../param/collection/DropDatabaseParam.html" title="class in io.milvus.param.collection"><code>DropDatabaseParam</code></a></dd>
  975. <dt><span class="returnLabel">Returns:</span></dt>
  976. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  977. </dl>
  978. </li>
  979. </ul>
  980. <a id="listDatabases()">
  981. <!-- -->
  982. </a>
  983. <ul class="blockList">
  984. <li class="blockList">
  985. <h4>listDatabases</h4>
  986. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListDatabasesResponse&gt;&nbsp;listDatabases()</pre>
  987. <div class="block">List databases. Note that this method list all database in the cluster.</div>
  988. <dl>
  989. <dt><span class="returnLabel">Returns:</span></dt>
  990. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  991. </dl>
  992. </li>
  993. </ul>
  994. <a id="createCollection(io.milvus.param.collection.CreateCollectionParam)">
  995. <!-- -->
  996. </a>
  997. <ul class="blockList">
  998. <li class="blockList">
  999. <h4>createCollection</h4>
  1000. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createCollection&#8203;(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a>&nbsp;requestParam)</pre>
  1001. <div class="block">Creates a collection in Milvus.</div>
  1002. <dl>
  1003. <dt><span class="paramLabel">Parameters:</span></dt>
  1004. <dd><code>requestParam</code> - <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
  1005. <dt><span class="returnLabel">Returns:</span></dt>
  1006. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1007. </dl>
  1008. </li>
  1009. </ul>
  1010. <a id="dropCollection(io.milvus.param.collection.DropCollectionParam)">
  1011. <!-- -->
  1012. </a>
  1013. <ul class="blockList">
  1014. <li class="blockList">
  1015. <h4>dropCollection</h4>
  1016. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropCollection&#8203;(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a>&nbsp;requestParam)</pre>
  1017. <div class="block">Drops a collection. Note that this method drops all data in the collection.</div>
  1018. <dl>
  1019. <dt><span class="paramLabel">Parameters:</span></dt>
  1020. <dd><code>requestParam</code> - <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection"><code>DropCollectionParam</code></a></dd>
  1021. <dt><span class="returnLabel">Returns:</span></dt>
  1022. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1023. </dl>
  1024. </li>
  1025. </ul>
  1026. <a id="loadCollection(io.milvus.param.collection.LoadCollectionParam)">
  1027. <!-- -->
  1028. </a>
  1029. <ul class="blockList">
  1030. <li class="blockList">
  1031. <h4>loadCollection</h4>
  1032. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;loadCollection&#8203;(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a>&nbsp;requestParam)</pre>
  1033. <div class="block">Loads a collection to memory before search or query.</div>
  1034. <dl>
  1035. <dt><span class="paramLabel">Parameters:</span></dt>
  1036. <dd><code>requestParam</code> - <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection"><code>LoadCollectionParam</code></a></dd>
  1037. <dt><span class="returnLabel">Returns:</span></dt>
  1038. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1039. </dl>
  1040. </li>
  1041. </ul>
  1042. <a id="releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">
  1043. <!-- -->
  1044. </a>
  1045. <ul class="blockList">
  1046. <li class="blockList">
  1047. <h4>releaseCollection</h4>
  1048. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;releaseCollection&#8203;(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a>&nbsp;requestParam)</pre>
  1049. <div class="block">Releases a collection from memory to reduce memory usage. Note that you
  1050. cannot search while the corresponding collection is released from memory.</div>
  1051. <dl>
  1052. <dt><span class="paramLabel">Parameters:</span></dt>
  1053. <dd><code>requestParam</code> - <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection"><code>ReleaseCollectionParam</code></a></dd>
  1054. <dt><span class="returnLabel">Returns:</span></dt>
  1055. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1056. </dl>
  1057. </li>
  1058. </ul>
  1059. <a id="describeCollection(io.milvus.param.collection.DescribeCollectionParam)">
  1060. <!-- -->
  1061. </a>
  1062. <ul class="blockList">
  1063. <li class="blockList">
  1064. <h4>describeCollection</h4>
  1065. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeCollectionResponse&gt;&nbsp;describeCollection&#8203;(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a>&nbsp;requestParam)</pre>
  1066. <div class="block">Shows the details of a collection, e.g. name, schema.</div>
  1067. <dl>
  1068. <dt><span class="paramLabel">Parameters:</span></dt>
  1069. <dd><code>requestParam</code> - <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection"><code>DescribeCollectionParam</code></a></dd>
  1070. <dt><span class="returnLabel">Returns:</span></dt>
  1071. <dd>{status:result code, data:DescribeCollectionResponse{schema,collectionID}}</dd>
  1072. </dl>
  1073. </li>
  1074. </ul>
  1075. <a id="getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">
  1076. <!-- -->
  1077. </a>
  1078. <ul class="blockList">
  1079. <li class="blockList">
  1080. <h4>getCollectionStatistics</h4>
  1081. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCollectionStatisticsResponse&gt;&nbsp;getCollectionStatistics&#8203;(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a>&nbsp;requestParam)</pre>
  1082. <div class="block">Shows the statistics information of a collection.</div>
  1083. <dl>
  1084. <dt><span class="paramLabel">Parameters:</span></dt>
  1085. <dd><code>requestParam</code> - <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><code>GetCollectionStatisticsParam</code></a></dd>
  1086. <dt><span class="returnLabel">Returns:</span></dt>
  1087. <dd>{status:result code, data: GetCollectionStatisticsResponse{status,stats}}</dd>
  1088. </dl>
  1089. </li>
  1090. </ul>
  1091. <a id="renameCollection(io.milvus.param.collection.RenameCollectionParam)">
  1092. <!-- -->
  1093. </a>
  1094. <ul class="blockList">
  1095. <li class="blockList">
  1096. <h4>renameCollection</h4>
  1097. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;renameCollection&#8203;(<a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection">RenameCollectionParam</a>&nbsp;requestParam)</pre>
  1098. <div class="block">rename a collection</div>
  1099. <dl>
  1100. <dt><span class="paramLabel">Parameters:</span></dt>
  1101. <dd><code>requestParam</code> - <a href="../param/collection/RenameCollectionParam.html" title="class in io.milvus.param.collection"><code>RenameCollectionParam</code></a></dd>
  1102. <dt><span class="returnLabel">Returns:</span></dt>
  1103. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1104. </dl>
  1105. </li>
  1106. </ul>
  1107. <a id="showCollections(io.milvus.param.collection.ShowCollectionsParam)">
  1108. <!-- -->
  1109. </a>
  1110. <ul class="blockList">
  1111. <li class="blockList">
  1112. <h4>showCollections</h4>
  1113. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowCollectionsResponse&gt;&nbsp;showCollections&#8203;(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a>&nbsp;requestParam)</pre>
  1114. <div class="block">Lists all collections or gets collection loading status.</div>
  1115. <dl>
  1116. <dt><span class="paramLabel">Parameters:</span></dt>
  1117. <dd><code>requestParam</code> - <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><code>ShowCollectionsParam</code></a></dd>
  1118. <dt><span class="returnLabel">Returns:</span></dt>
  1119. <dd>{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}</dd>
  1120. </dl>
  1121. </li>
  1122. </ul>
  1123. <a id="alterCollection(io.milvus.param.collection.AlterCollectionParam)">
  1124. <!-- -->
  1125. </a>
  1126. <ul class="blockList">
  1127. <li class="blockList">
  1128. <h4>alterCollection</h4>
  1129. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;alterCollection&#8203;(<a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection">AlterCollectionParam</a>&nbsp;requestParam)</pre>
  1130. <div class="block">Alter collection.
  1131. Currently, only support setting collection TTL with key `collection.ttl.seconds`</div>
  1132. <dl>
  1133. <dt><span class="paramLabel">Parameters:</span></dt>
  1134. <dd><code>requestParam</code> - <a href="../param/collection/AlterCollectionParam.html" title="class in io.milvus.param.collection"><code>AlterCollectionParam</code></a></dd>
  1135. <dt><span class="returnLabel">Returns:</span></dt>
  1136. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1137. </dl>
  1138. </li>
  1139. </ul>
  1140. <a id="flush(io.milvus.param.collection.FlushParam)">
  1141. <!-- -->
  1142. </a>
  1143. <ul class="blockList">
  1144. <li class="blockList">
  1145. <h4>flush</h4>
  1146. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushResponse&gt;&nbsp;flush&#8203;(<a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a>&nbsp;requestParam)</pre>
  1147. <div class="block">Flushes inserted data in buffer into storage.</div>
  1148. <dl>
  1149. <dt><span class="paramLabel">Parameters:</span></dt>
  1150. <dd><code>requestParam</code> - <a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection"><code>FlushParam</code></a></dd>
  1151. <dt><span class="returnLabel">Returns:</span></dt>
  1152. <dd>{status:result code,data: FlushResponse{flush segment ids}}</dd>
  1153. </dl>
  1154. </li>
  1155. </ul>
  1156. <a id="flushAll(boolean,long,long)">
  1157. <!-- -->
  1158. </a>
  1159. <ul class="blockList">
  1160. <li class="blockList">
  1161. <h4>flushAll</h4>
  1162. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.FlushAllResponse&gt;&nbsp;flushAll&#8203;(boolean&nbsp;syncFlushAll,
  1163. long&nbsp;syncFlushAllWaitingInterval,
  1164. long&nbsp;syncFlushAllTimeout)</pre>
  1165. <div class="block">Flush all collections. All insertions, deletions, and upserts before `flushAll` will be synced.</div>
  1166. <dl>
  1167. <dt><span class="paramLabel">Parameters:</span></dt>
  1168. <dd><code>syncFlushAll</code> - {flushAll synchronously or asynchronously}</dd>
  1169. <dd><code>syncFlushAllWaitingInterval</code> - {wait intervel when flushAll synchronously}</dd>
  1170. <dd><code>syncFlushAllTimeout</code> - {timeout when flushAll synchronously}</dd>
  1171. <dt><span class="returnLabel">Returns:</span></dt>
  1172. <dd>{status:result code,data: FlushAllResponse{flushAllTs}}</dd>
  1173. </dl>
  1174. </li>
  1175. </ul>
  1176. <a id="createPartition(io.milvus.param.partition.CreatePartitionParam)">
  1177. <!-- -->
  1178. </a>
  1179. <ul class="blockList">
  1180. <li class="blockList">
  1181. <h4>createPartition</h4>
  1182. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createPartition&#8203;(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a>&nbsp;requestParam)</pre>
  1183. <div class="block">Creates a partition in the specified collection.</div>
  1184. <dl>
  1185. <dt><span class="paramLabel">Parameters:</span></dt>
  1186. <dd><code>requestParam</code> - <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition"><code>CreatePartitionParam</code></a></dd>
  1187. <dt><span class="returnLabel">Returns:</span></dt>
  1188. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1189. </dl>
  1190. </li>
  1191. </ul>
  1192. <a id="dropPartition(io.milvus.param.partition.DropPartitionParam)">
  1193. <!-- -->
  1194. </a>
  1195. <ul class="blockList">
  1196. <li class="blockList">
  1197. <h4>dropPartition</h4>
  1198. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropPartition&#8203;(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a>&nbsp;requestParam)</pre>
  1199. <div class="block">Drops a partition. Note that this method drops all data in this partition
  1200. and the _default partition cannot be dropped.</div>
  1201. <dl>
  1202. <dt><span class="paramLabel">Parameters:</span></dt>
  1203. <dd><code>requestParam</code> - <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition"><code>DropPartitionParam</code></a></dd>
  1204. <dt><span class="returnLabel">Returns:</span></dt>
  1205. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1206. </dl>
  1207. </li>
  1208. </ul>
  1209. <a id="hasPartition(io.milvus.param.partition.HasPartitionParam)">
  1210. <!-- -->
  1211. </a>
  1212. <ul class="blockList">
  1213. <li class="blockList">
  1214. <h4>hasPartition</h4>
  1215. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;java.lang.Boolean&gt;&nbsp;hasPartition&#8203;(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a>&nbsp;requestParam)</pre>
  1216. <div class="block">Checks if a partition exists in the specified collection.</div>
  1217. <dl>
  1218. <dt><span class="paramLabel">Parameters:</span></dt>
  1219. <dd><code>requestParam</code> - <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition"><code>HasPartitionParam</code></a></dd>
  1220. <dt><span class="returnLabel">Returns:</span></dt>
  1221. <dd>{status:result code, data: boolean, whether if has collection or not}</dd>
  1222. </dl>
  1223. </li>
  1224. </ul>
  1225. <a id="loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">
  1226. <!-- -->
  1227. </a>
  1228. <ul class="blockList">
  1229. <li class="blockList">
  1230. <h4>loadPartitions</h4>
  1231. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;loadPartitions&#8203;(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a>&nbsp;requestParam)</pre>
  1232. <div class="block">Loads a partition into memory.</div>
  1233. <dl>
  1234. <dt><span class="paramLabel">Parameters:</span></dt>
  1235. <dd><code>requestParam</code> - <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition"><code>LoadPartitionsParam</code></a></dd>
  1236. <dt><span class="returnLabel">Returns:</span></dt>
  1237. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1238. </dl>
  1239. </li>
  1240. </ul>
  1241. <a id="releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">
  1242. <!-- -->
  1243. </a>
  1244. <ul class="blockList">
  1245. <li class="blockList">
  1246. <h4>releasePartitions</h4>
  1247. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;releasePartitions&#8203;(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a>&nbsp;requestParam)</pre>
  1248. <div class="block">Releases a partition from memory.</div>
  1249. <dl>
  1250. <dt><span class="paramLabel">Parameters:</span></dt>
  1251. <dd><code>requestParam</code> - <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition"><code>ReleasePartitionsParam</code></a></dd>
  1252. <dt><span class="returnLabel">Returns:</span></dt>
  1253. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1254. </dl>
  1255. </li>
  1256. </ul>
  1257. <a id="getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">
  1258. <!-- -->
  1259. </a>
  1260. <ul class="blockList">
  1261. <li class="blockList">
  1262. <h4>getPartitionStatistics</h4>
  1263. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPartitionStatisticsResponse&gt;&nbsp;getPartitionStatistics&#8203;(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a>&nbsp;requestParam)</pre>
  1264. <div class="block">Shows the statistics information of a partition.</div>
  1265. <dl>
  1266. <dt><span class="paramLabel">Parameters:</span></dt>
  1267. <dd><code>requestParam</code> - <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><code>GetPartitionStatisticsParam</code></a></dd>
  1268. <dt><span class="returnLabel">Returns:</span></dt>
  1269. <dd>{status:result code,data:GetPartitionStatisticsResponse{status,stats}}</dd>
  1270. </dl>
  1271. </li>
  1272. </ul>
  1273. <a id="showPartitions(io.milvus.param.partition.ShowPartitionsParam)">
  1274. <!-- -->
  1275. </a>
  1276. <ul class="blockList">
  1277. <li class="blockList">
  1278. <h4>showPartitions</h4>
  1279. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ShowPartitionsResponse&gt;&nbsp;showPartitions&#8203;(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a>&nbsp;requestParam)</pre>
  1280. <div class="block">Shows all partitions in the specified collection.</div>
  1281. <dl>
  1282. <dt><span class="paramLabel">Parameters:</span></dt>
  1283. <dd><code>requestParam</code> - <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><code>ShowPartitionsParam</code></a></dd>
  1284. <dt><span class="returnLabel">Returns:</span></dt>
  1285. <dd>{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}</dd>
  1286. </dl>
  1287. </li>
  1288. </ul>
  1289. <a id="createAlias(io.milvus.param.alias.CreateAliasParam)">
  1290. <!-- -->
  1291. </a>
  1292. <ul class="blockList">
  1293. <li class="blockList">
  1294. <h4>createAlias</h4>
  1295. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createAlias&#8203;(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a>&nbsp;requestParam)</pre>
  1296. <div class="block">Creates an alias for a collection.
  1297. Alias can be used in search or query to replace the collection name</div>
  1298. <dl>
  1299. <dt><span class="paramLabel">Parameters:</span></dt>
  1300. <dd><code>requestParam</code> - <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias"><code>CreateAliasParam</code></a></dd>
  1301. <dt><span class="returnLabel">Returns:</span></dt>
  1302. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1303. </dl>
  1304. </li>
  1305. </ul>
  1306. <a id="dropAlias(io.milvus.param.alias.DropAliasParam)">
  1307. <!-- -->
  1308. </a>
  1309. <ul class="blockList">
  1310. <li class="blockList">
  1311. <h4>dropAlias</h4>
  1312. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropAlias&#8203;(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a>&nbsp;requestParam)</pre>
  1313. <div class="block">Drops an alias for the specified collection.</div>
  1314. <dl>
  1315. <dt><span class="paramLabel">Parameters:</span></dt>
  1316. <dd><code>requestParam</code> - <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias"><code>DropAliasParam</code></a></dd>
  1317. <dt><span class="returnLabel">Returns:</span></dt>
  1318. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1319. </dl>
  1320. </li>
  1321. </ul>
  1322. <a id="alterAlias(io.milvus.param.alias.AlterAliasParam)">
  1323. <!-- -->
  1324. </a>
  1325. <ul class="blockList">
  1326. <li class="blockList">
  1327. <h4>alterAlias</h4>
  1328. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;alterAlias&#8203;(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a>&nbsp;requestParam)</pre>
  1329. <div class="block">Alters alias from a collection to another.</div>
  1330. <dl>
  1331. <dt><span class="paramLabel">Parameters:</span></dt>
  1332. <dd><code>requestParam</code> - <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias"><code>AlterAliasParam</code></a></dd>
  1333. <dt><span class="returnLabel">Returns:</span></dt>
  1334. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1335. </dl>
  1336. </li>
  1337. </ul>
  1338. <a id="listAliases(io.milvus.param.alias.ListAliasesParam)">
  1339. <!-- -->
  1340. </a>
  1341. <ul class="blockList">
  1342. <li class="blockList">
  1343. <h4>listAliases</h4>
  1344. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListAliasesResponse&gt;&nbsp;listAliases&#8203;(<a href="../param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias">ListAliasesParam</a>&nbsp;requestParam)</pre>
  1345. <div class="block">List all alias for a collection.</div>
  1346. <dl>
  1347. <dt><span class="paramLabel">Parameters:</span></dt>
  1348. <dd><code>requestParam</code> - <a href="../param/alias/ListAliasesParam.html" title="class in io.milvus.param.alias"><code>ListAliasesParam</code></a></dd>
  1349. <dt><span class="returnLabel">Returns:</span></dt>
  1350. <dd>{status:result code, data:ListAliasesResponse{status, aliases}}</dd>
  1351. </dl>
  1352. </li>
  1353. </ul>
  1354. <a id="createIndex(io.milvus.param.index.CreateIndexParam)">
  1355. <!-- -->
  1356. </a>
  1357. <ul class="blockList">
  1358. <li class="blockList">
  1359. <h4>createIndex</h4>
  1360. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createIndex&#8203;(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a>&nbsp;requestParam)</pre>
  1361. <div class="block">Creates an index on a vector field in the specified collection.
  1362. Note that index building is an async progress.</div>
  1363. <dl>
  1364. <dt><span class="paramLabel">Parameters:</span></dt>
  1365. <dd><code>requestParam</code> - <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index"><code>CreateIndexParam</code></a></dd>
  1366. <dt><span class="returnLabel">Returns:</span></dt>
  1367. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1368. </dl>
  1369. </li>
  1370. </ul>
  1371. <a id="dropIndex(io.milvus.param.index.DropIndexParam)">
  1372. <!-- -->
  1373. </a>
  1374. <ul class="blockList">
  1375. <li class="blockList">
  1376. <h4>dropIndex</h4>
  1377. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropIndex&#8203;(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a>&nbsp;requestParam)</pre>
  1378. <div class="block">Drops the index on a vector field in the specified collection.</div>
  1379. <dl>
  1380. <dt><span class="paramLabel">Parameters:</span></dt>
  1381. <dd><code>requestParam</code> - <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index"><code>DropIndexParam</code></a></dd>
  1382. <dt><span class="returnLabel">Returns:</span></dt>
  1383. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1384. </dl>
  1385. </li>
  1386. </ul>
  1387. <a id="describeIndex(io.milvus.param.index.DescribeIndexParam)">
  1388. <!-- -->
  1389. </a>
  1390. <ul class="blockList">
  1391. <li class="blockList">
  1392. <h4>describeIndex</h4>
  1393. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeIndexResponse&gt;&nbsp;describeIndex&#8203;(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a>&nbsp;requestParam)</pre>
  1394. <div class="block">Shows the information of the specified index. Current release of Milvus
  1395. only supports showing latest built index.</div>
  1396. <dl>
  1397. <dt><span class="paramLabel">Parameters:</span></dt>
  1398. <dd><code>requestParam</code> - <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index"><code>DescribeIndexParam</code></a></dd>
  1399. <dt><span class="returnLabel">Returns:</span></dt>
  1400. <dd>{status:result code, data:DescribeIndexResponse{status,index_descriptions}}</dd>
  1401. </dl>
  1402. </li>
  1403. </ul>
  1404. <a id="getIndexState(io.milvus.param.index.GetIndexStateParam)">
  1405. <!-- -->
  1406. </a>
  1407. <ul class="blockList">
  1408. <li class="blockList">
  1409. <h4>getIndexState</h4>
  1410. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexStateResponse&gt;&nbsp;getIndexState&#8203;(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a>&nbsp;requestParam)</pre>
  1411. <div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
  1412. <dl>
  1413. <dt><span class="paramLabel">Parameters:</span></dt>
  1414. <dd><code>requestParam</code> - <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><code>GetIndexStateParam</code></a></dd>
  1415. <dt><span class="returnLabel">Returns:</span></dt>
  1416. <dd>{status:result code, data:GetIndexStateResponse{status,state}}</dd>
  1417. </dl>
  1418. </li>
  1419. </ul>
  1420. <a id="getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">
  1421. <!-- -->
  1422. </a>
  1423. <ul class="blockList">
  1424. <li class="blockList">
  1425. <h4>getIndexBuildProgress</h4>
  1426. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetIndexBuildProgressResponse&gt;&nbsp;getIndexBuildProgress&#8203;(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a>&nbsp;requestParam)</pre>
  1427. <div class="block">Shows the index building progress, such as how many rows are indexed.</div>
  1428. <dl>
  1429. <dt><span class="paramLabel">Parameters:</span></dt>
  1430. <dd><code>requestParam</code> - <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><code>GetIndexBuildProgressParam</code></a></dd>
  1431. <dt><span class="returnLabel">Returns:</span></dt>
  1432. <dd>{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}</dd>
  1433. </dl>
  1434. </li>
  1435. </ul>
  1436. <a id="insert(io.milvus.param.dml.InsertParam)">
  1437. <!-- -->
  1438. </a>
  1439. <ul class="blockList">
  1440. <li class="blockList">
  1441. <h4>insert</h4>
  1442. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;insert&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</pre>
  1443. <div class="block">Inserts entities into a specified collection . Note that you don't need to
  1444. input primary key field if auto_id is enabled.</div>
  1445. <dl>
  1446. <dt><span class="paramLabel">Parameters:</span></dt>
  1447. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
  1448. <dt><span class="returnLabel">Returns:</span></dt>
  1449. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  1450. </dl>
  1451. </li>
  1452. </ul>
  1453. <a id="insertAsync(io.milvus.param.dml.InsertParam)">
  1454. <!-- -->
  1455. </a>
  1456. <ul class="blockList">
  1457. <li class="blockList">
  1458. <h4>insertAsync</h4>
  1459. <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;&nbsp;insertAsync&#8203;(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a>&nbsp;requestParam)</pre>
  1460. <div class="block">Inserts entities into a specified collection asynchronously. Note that you don't need to
  1461. input primary key field if auto_id is enabled.</div>
  1462. <dl>
  1463. <dt><span class="paramLabel">Parameters:</span></dt>
  1464. <dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
  1465. <dt><span class="returnLabel">Returns:</span></dt>
  1466. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
  1467. </dl>
  1468. </li>
  1469. </ul>
  1470. <a id="upsert(io.milvus.param.dml.UpsertParam)">
  1471. <!-- -->
  1472. </a>
  1473. <ul class="blockList">
  1474. <li class="blockList">
  1475. <h4>upsert</h4>
  1476. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;upsert&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</pre>
  1477. <div class="block">Insert new entities into a specified collection, replace them if the entities already exist.</div>
  1478. <dl>
  1479. <dt><span class="paramLabel">Parameters:</span></dt>
  1480. <dd><code>requestParam</code> - <a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
  1481. <dt><span class="returnLabel">Returns:</span></dt>
  1482. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  1483. </dl>
  1484. </li>
  1485. </ul>
  1486. <a id="upsertAsync(io.milvus.param.dml.UpsertParam)">
  1487. <!-- -->
  1488. </a>
  1489. <ul class="blockList">
  1490. <li class="blockList">
  1491. <h4>upsertAsync</h4>
  1492. <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&gt;&nbsp;upsertAsync&#8203;(<a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml">UpsertParam</a>&nbsp;requestParam)</pre>
  1493. <div class="block">Insert new entities into a specified collection asynchronously, replace them if the entities already exist.</div>
  1494. <dl>
  1495. <dt><span class="paramLabel">Parameters:</span></dt>
  1496. <dd><code>requestParam</code> - <a href="../param/dml/UpsertParam.html" title="class in io.milvus.param.dml"><code>UpsertParam</code></a></dd>
  1497. <dt><span class="returnLabel">Returns:</span></dt>
  1498. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
  1499. </dl>
  1500. </li>
  1501. </ul>
  1502. <a id="delete(io.milvus.param.dml.DeleteParam)">
  1503. <!-- -->
  1504. </a>
  1505. <ul class="blockList">
  1506. <li class="blockList">
  1507. <h4>delete</h4>
  1508. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.MutationResult&gt;&nbsp;delete&#8203;(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a>&nbsp;requestParam)</pre>
  1509. <div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release
  1510. of Milvus only supports expression in the format "pk_field in [1, 2, ...]"</div>
  1511. <dl>
  1512. <dt><span class="paramLabel">Parameters:</span></dt>
  1513. <dd><code>requestParam</code> - <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml"><code>DeleteParam</code></a></dd>
  1514. <dt><span class="returnLabel">Returns:</span></dt>
  1515. <dd>{status:result code, data: MutationResult{delete results}}</dd>
  1516. </dl>
  1517. </li>
  1518. </ul>
  1519. <a id="search(io.milvus.param.dml.SearchParam)">
  1520. <!-- -->
  1521. </a>
  1522. <ul class="blockList">
  1523. <li class="blockList">
  1524. <h4>search</h4>
  1525. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&nbsp;search&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</pre>
  1526. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
  1527. <dl>
  1528. <dt><span class="paramLabel">Parameters:</span></dt>
  1529. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
  1530. <dt><span class="returnLabel">Returns:</span></dt>
  1531. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  1532. </dl>
  1533. </li>
  1534. </ul>
  1535. <a id="searchAsync(io.milvus.param.dml.SearchParam)">
  1536. <!-- -->
  1537. </a>
  1538. <ul class="blockList">
  1539. <li class="blockList">
  1540. <h4>searchAsync</h4>
  1541. <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SearchResults&gt;&gt;&nbsp;searchAsync&#8203;(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</pre>
  1542. <div class="block">Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.</div>
  1543. <dl>
  1544. <dt><span class="paramLabel">Parameters:</span></dt>
  1545. <dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
  1546. <dt><span class="returnLabel">Returns:</span></dt>
  1547. <dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
  1548. </dl>
  1549. </li>
  1550. </ul>
  1551. <a id="query(io.milvus.param.dml.QueryParam)">
  1552. <!-- -->
  1553. </a>
  1554. <ul class="blockList">
  1555. <li class="blockList">
  1556. <h4>query</h4>
  1557. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&nbsp;query&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</pre>
  1558. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
  1559. Note that the order of the returned entities cannot be guaranteed.</div>
  1560. <dl>
  1561. <dt><span class="paramLabel">Parameters:</span></dt>
  1562. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
  1563. <dt><span class="returnLabel">Returns:</span></dt>
  1564. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  1565. </dl>
  1566. </li>
  1567. </ul>
  1568. <a id="queryAsync(io.milvus.param.dml.QueryParam)">
  1569. <!-- -->
  1570. </a>
  1571. <ul class="blockList">
  1572. <li class="blockList">
  1573. <h4>queryAsync</h4>
  1574. <pre class="methodSignature">com.google.common.util.concurrent.ListenableFuture&lt;<a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.QueryResults&gt;&gt;&nbsp;queryAsync&#8203;(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</pre>
  1575. <div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.
  1576. Note that the order of the returned entities cannot be guaranteed.</div>
  1577. <dl>
  1578. <dt><span class="paramLabel">Parameters:</span></dt>
  1579. <dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
  1580. <dt><span class="returnLabel">Returns:</span></dt>
  1581. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  1582. </dl>
  1583. </li>
  1584. </ul>
  1585. <a id="getMetrics(io.milvus.param.control.GetMetricsParam)">
  1586. <!-- -->
  1587. </a>
  1588. <ul class="blockList">
  1589. <li class="blockList">
  1590. <h4>getMetrics</h4>
  1591. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetMetricsResponse&gt;&nbsp;getMetrics&#8203;(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a>&nbsp;requestParam)</pre>
  1592. <div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
  1593. <dl>
  1594. <dt><span class="paramLabel">Parameters:</span></dt>
  1595. <dd><code>requestParam</code> - <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><code>GetMetricsParam</code></a></dd>
  1596. <dt><span class="returnLabel">Returns:</span></dt>
  1597. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1598. </dl>
  1599. </li>
  1600. </ul>
  1601. <a id="getFlushState(io.milvus.param.control.GetFlushStateParam)">
  1602. <!-- -->
  1603. </a>
  1604. <ul class="blockList">
  1605. <li class="blockList">
  1606. <h4>getFlushState</h4>
  1607. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushStateResponse&gt;&nbsp;getFlushState&#8203;(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a>&nbsp;requestParam)</pre>
  1608. <div class="block">Get flush state of specified collection.</div>
  1609. <dl>
  1610. <dt><span class="paramLabel">Parameters:</span></dt>
  1611. <dd><code>requestParam</code> - <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><code>GetFlushStateParam</code></a></dd>
  1612. <dt><span class="returnLabel">Returns:</span></dt>
  1613. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1614. </dl>
  1615. </li>
  1616. </ul>
  1617. <a id="getFlushAllState(io.milvus.param.control.GetFlushAllStateParam)">
  1618. <!-- -->
  1619. </a>
  1620. <ul class="blockList">
  1621. <li class="blockList">
  1622. <h4>getFlushAllState</h4>
  1623. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetFlushAllStateResponse&gt;&nbsp;getFlushAllState&#8203;(<a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control">GetFlushAllStateParam</a>&nbsp;requestParam)</pre>
  1624. <div class="block">Get flush state of all segments.</div>
  1625. <dl>
  1626. <dt><span class="paramLabel">Parameters:</span></dt>
  1627. <dd><code>requestParam</code> - <a href="../param/control/GetFlushAllStateParam.html" title="class in io.milvus.param.control"><code>GetFlushAllStateParam</code></a></dd>
  1628. <dt><span class="returnLabel">Returns:</span></dt>
  1629. <dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
  1630. </dl>
  1631. </li>
  1632. </ul>
  1633. <a id="getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">
  1634. <!-- -->
  1635. </a>
  1636. <ul class="blockList">
  1637. <li class="blockList">
  1638. <h4>getPersistentSegmentInfo</h4>
  1639. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetPersistentSegmentInfoResponse&gt;&nbsp;getPersistentSegmentInfo&#8203;(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a>&nbsp;requestParam)</pre>
  1640. <div class="block">Gets the information of persistent segments from data node, including row count,
  1641. persistence state(growing or flushed), etc.</div>
  1642. <dl>
  1643. <dt><span class="paramLabel">Parameters:</span></dt>
  1644. <dd><code>requestParam</code> - <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetPersistentSegmentInfoParam</code></a></dd>
  1645. <dt><span class="returnLabel">Returns:</span></dt>
  1646. <dd>{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}</dd>
  1647. </dl>
  1648. </li>
  1649. </ul>
  1650. <a id="getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">
  1651. <!-- -->
  1652. </a>
  1653. <ul class="blockList">
  1654. <li class="blockList">
  1655. <h4>getQuerySegmentInfo</h4>
  1656. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetQuerySegmentInfoResponse&gt;&nbsp;getQuerySegmentInfo&#8203;(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a>&nbsp;requestParam)</pre>
  1657. <div class="block">Gets the query information of segments in a collection from query node, including row count,
  1658. memory usage size, index name, etc.</div>
  1659. <dl>
  1660. <dt><span class="paramLabel">Parameters:</span></dt>
  1661. <dd><code>requestParam</code> - <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetQuerySegmentInfoParam</code></a></dd>
  1662. <dt><span class="returnLabel">Returns:</span></dt>
  1663. <dd>{status:result code, data:GetQuerySegmentInfoResponse{status,info}}</dd>
  1664. </dl>
  1665. </li>
  1666. </ul>
  1667. <a id="getReplicas(io.milvus.param.control.GetReplicasParam)">
  1668. <!-- -->
  1669. </a>
  1670. <ul class="blockList">
  1671. <li class="blockList">
  1672. <h4>getReplicas</h4>
  1673. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetReplicasResponse&gt;&nbsp;getReplicas&#8203;(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a>&nbsp;requestParam)</pre>
  1674. <div class="block">Returns the collection's replica information</div>
  1675. <dl>
  1676. <dt><span class="paramLabel">Parameters:</span></dt>
  1677. <dd><code>requestParam</code> - <a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control"><code>GetReplicasParam</code></a></dd>
  1678. <dt><span class="returnLabel">Returns:</span></dt>
  1679. <dd>{status:result code, data:GetReplicasResponse{status,info}}</dd>
  1680. </dl>
  1681. </li>
  1682. </ul>
  1683. <a id="loadBalance(io.milvus.param.control.LoadBalanceParam)">
  1684. <!-- -->
  1685. </a>
  1686. <ul class="blockList">
  1687. <li class="blockList">
  1688. <h4>loadBalance</h4>
  1689. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;loadBalance&#8203;(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a>&nbsp;requestParam)</pre>
  1690. <div class="block">Moves segment from a query node to another to keep the load balanced.</div>
  1691. <dl>
  1692. <dt><span class="paramLabel">Parameters:</span></dt>
  1693. <dd><code>requestParam</code> - <a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control"><code>LoadBalanceParam</code></a></dd>
  1694. <dt><span class="returnLabel">Returns:</span></dt>
  1695. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1696. </dl>
  1697. </li>
  1698. </ul>
  1699. <a id="getCompactionState(io.milvus.param.control.GetCompactionStateParam)">
  1700. <!-- -->
  1701. </a>
  1702. <ul class="blockList">
  1703. <li class="blockList">
  1704. <h4>getCompactionState</h4>
  1705. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionStateResponse&gt;&nbsp;getCompactionState&#8203;(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a>&nbsp;requestParam)</pre>
  1706. <div class="block">Gets the compaction state by id.</div>
  1707. <dl>
  1708. <dt><span class="paramLabel">Parameters:</span></dt>
  1709. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><code>GetCompactionStateParam</code></a></dd>
  1710. <dt><span class="returnLabel">Returns:</span></dt>
  1711. <dd>{status:result code, data:GetCompactionStateResponse{status,info}}</dd>
  1712. </dl>
  1713. </li>
  1714. </ul>
  1715. <a id="manualCompact(io.milvus.param.control.ManualCompactParam)">
  1716. <!-- -->
  1717. </a>
  1718. <ul class="blockList">
  1719. <li class="blockList">
  1720. <h4>manualCompact</h4>
  1721. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ManualCompactionResponse&gt;&nbsp;manualCompact&#8203;(<a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control">ManualCompactParam</a>&nbsp;requestParam)</pre>
  1722. <div class="block">Performs a manual compaction.</div>
  1723. <dl>
  1724. <dt><span class="paramLabel">Parameters:</span></dt>
  1725. <dd><code>requestParam</code> - <a href="../param/control/ManualCompactParam.html" title="class in io.milvus.param.control"><code>ManualCompactParam</code></a></dd>
  1726. <dt><span class="returnLabel">Returns:</span></dt>
  1727. <dd>{status:result code, data:ManualCompactionResponse{status,info}}</dd>
  1728. </dl>
  1729. </li>
  1730. </ul>
  1731. <a id="getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">
  1732. <!-- -->
  1733. </a>
  1734. <ul class="blockList">
  1735. <li class="blockList">
  1736. <h4>getCompactionStateWithPlans</h4>
  1737. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetCompactionPlansResponse&gt;&nbsp;getCompactionStateWithPlans&#8203;(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a>&nbsp;requestParam)</pre>
  1738. <div class="block">Gets compaction state with its plan.</div>
  1739. <dl>
  1740. <dt><span class="paramLabel">Parameters:</span></dt>
  1741. <dd><code>requestParam</code> - <a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><code>GetCompactionPlansParam</code></a></dd>
  1742. <dt><span class="returnLabel">Returns:</span></dt>
  1743. <dd>{status:result code, data:GetCompactionPlansResponse{status,info}}</dd>
  1744. </dl>
  1745. </li>
  1746. </ul>
  1747. <a id="createCredential(io.milvus.param.credential.CreateCredentialParam)">
  1748. <!-- -->
  1749. </a>
  1750. <ul class="blockList">
  1751. <li class="blockList">
  1752. <h4>createCredential</h4>
  1753. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createCredential&#8203;(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a>&nbsp;requestParam)</pre>
  1754. <div class="block">Create credential using the given user and password.</div>
  1755. <dl>
  1756. <dt><span class="paramLabel">Parameters:</span></dt>
  1757. <dd><code>requestParam</code> - <a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential"><code>CreateCredentialParam</code></a></dd>
  1758. <dt><span class="returnLabel">Returns:</span></dt>
  1759. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1760. </dl>
  1761. </li>
  1762. </ul>
  1763. <a id="updateCredential(io.milvus.param.credential.UpdateCredentialParam)">
  1764. <!-- -->
  1765. </a>
  1766. <ul class="blockList">
  1767. <li class="blockList">
  1768. <h4>updateCredential</h4>
  1769. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;updateCredential&#8203;(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a>&nbsp;requestParam)</pre>
  1770. <div class="block">Update credential using the given user and password.
  1771. You must provide the original password to check if the operation is valid.
  1772. Note: after this operation, client won't change the related header of this connection.
  1773. So if you update credential for this connection, the connection may be invalid.</div>
  1774. <dl>
  1775. <dt><span class="paramLabel">Parameters:</span></dt>
  1776. <dd><code>requestParam</code> - <a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential"><code>UpdateCredentialParam</code></a></dd>
  1777. <dt><span class="returnLabel">Returns:</span></dt>
  1778. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1779. </dl>
  1780. </li>
  1781. </ul>
  1782. <a id="deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">
  1783. <!-- -->
  1784. </a>
  1785. <ul class="blockList">
  1786. <li class="blockList">
  1787. <h4>deleteCredential</h4>
  1788. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;deleteCredential&#8203;(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a>&nbsp;requestParam)</pre>
  1789. <div class="block">Delete credential corresponding to the user.</div>
  1790. <dl>
  1791. <dt><span class="paramLabel">Parameters:</span></dt>
  1792. <dd><code>requestParam</code> - <a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential"><code>DeleteCredentialParam</code></a></dd>
  1793. <dt><span class="returnLabel">Returns:</span></dt>
  1794. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1795. </dl>
  1796. </li>
  1797. </ul>
  1798. <a id="listCredUsers(io.milvus.param.credential.ListCredUsersParam)">
  1799. <!-- -->
  1800. </a>
  1801. <ul class="blockList">
  1802. <li class="blockList">
  1803. <h4>listCredUsers</h4>
  1804. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListCredUsersResponse&gt;&nbsp;listCredUsers&#8203;(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a>&nbsp;requestParam)</pre>
  1805. <div class="block">List all user names.</div>
  1806. <dl>
  1807. <dt><span class="paramLabel">Parameters:</span></dt>
  1808. <dd><code>requestParam</code> - <a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential"><code>ListCredUsersParam</code></a></dd>
  1809. <dt><span class="returnLabel">Returns:</span></dt>
  1810. <dd>{status:result code, data:ListCredUsersResponse{status,info}}</dd>
  1811. </dl>
  1812. </li>
  1813. </ul>
  1814. <a id="createRole(io.milvus.param.role.CreateRoleParam)">
  1815. <!-- -->
  1816. </a>
  1817. <ul class="blockList">
  1818. <li class="blockList">
  1819. <h4>createRole</h4>
  1820. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createRole&#8203;(<a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role">CreateRoleParam</a>&nbsp;requestParam)</pre>
  1821. <div class="block">It will success if the role isn't existed, otherwise fail.</div>
  1822. <dl>
  1823. <dt><span class="paramLabel">Parameters:</span></dt>
  1824. <dd><code>requestParam</code> - <a href="../param/role/CreateRoleParam.html" title="class in io.milvus.param.role"><code>CreateRoleParam</code></a></dd>
  1825. <dt><span class="returnLabel">Returns:</span></dt>
  1826. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1827. </dl>
  1828. </li>
  1829. </ul>
  1830. <a id="dropRole(io.milvus.param.role.DropRoleParam)">
  1831. <!-- -->
  1832. </a>
  1833. <ul class="blockList">
  1834. <li class="blockList">
  1835. <h4>dropRole</h4>
  1836. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropRole&#8203;(<a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role">DropRoleParam</a>&nbsp;requestParam)</pre>
  1837. <div class="block">It will success if the role is existed, otherwise fail.</div>
  1838. <dl>
  1839. <dt><span class="paramLabel">Parameters:</span></dt>
  1840. <dd><code>requestParam</code> - <a href="../param/role/DropRoleParam.html" title="class in io.milvus.param.role"><code>DropRoleParam</code></a></dd>
  1841. <dt><span class="returnLabel">Returns:</span></dt>
  1842. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1843. </dl>
  1844. </li>
  1845. </ul>
  1846. <a id="addUserToRole(io.milvus.param.role.AddUserToRoleParam)">
  1847. <!-- -->
  1848. </a>
  1849. <ul class="blockList">
  1850. <li class="blockList">
  1851. <h4>addUserToRole</h4>
  1852. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;addUserToRole&#8203;(<a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role">AddUserToRoleParam</a>&nbsp;requestParam)</pre>
  1853. <div class="block">The user will get permissions that the role are allowed to perform operations.</div>
  1854. <dl>
  1855. <dt><span class="paramLabel">Parameters:</span></dt>
  1856. <dd><code>requestParam</code> - <a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
  1857. <dt><span class="returnLabel">Returns:</span></dt>
  1858. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1859. </dl>
  1860. </li>
  1861. </ul>
  1862. <a id="removeUserFromRole(io.milvus.param.role.RemoveUserFromRoleParam)">
  1863. <!-- -->
  1864. </a>
  1865. <ul class="blockList">
  1866. <li class="blockList">
  1867. <h4>removeUserFromRole</h4>
  1868. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;removeUserFromRole&#8203;(<a href="../param/role/RemoveUserFromRoleParam.html" title="class in io.milvus.param.role">RemoveUserFromRoleParam</a>&nbsp;requestParam)</pre>
  1869. <div class="block">The user will remove permissions that the role are allowed to perform operations.</div>
  1870. <dl>
  1871. <dt><span class="paramLabel">Parameters:</span></dt>
  1872. <dd><code>requestParam</code> - <a href="../param/role/AddUserToRoleParam.html" title="class in io.milvus.param.role"><code>AddUserToRoleParam</code></a></dd>
  1873. <dt><span class="returnLabel">Returns:</span></dt>
  1874. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1875. </dl>
  1876. </li>
  1877. </ul>
  1878. <a id="selectRole(io.milvus.param.role.SelectRoleParam)">
  1879. <!-- -->
  1880. </a>
  1881. <ul class="blockList">
  1882. <li class="blockList">
  1883. <h4>selectRole</h4>
  1884. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectRoleResponse&gt;&nbsp;selectRole&#8203;(<a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role">SelectRoleParam</a>&nbsp;requestParam)</pre>
  1885. <div class="block">Get all users who are added to the role.</div>
  1886. <dl>
  1887. <dt><span class="paramLabel">Parameters:</span></dt>
  1888. <dd><code>requestParam</code> - <a href="../param/role/SelectRoleParam.html" title="class in io.milvus.param.role"><code>SelectRoleParam</code></a></dd>
  1889. <dt><span class="returnLabel">Returns:</span></dt>
  1890. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  1891. </dl>
  1892. </li>
  1893. </ul>
  1894. <a id="selectUser(io.milvus.param.role.SelectUserParam)">
  1895. <!-- -->
  1896. </a>
  1897. <ul class="blockList">
  1898. <li class="blockList">
  1899. <h4>selectUser</h4>
  1900. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectUserResponse&gt;&nbsp;selectUser&#8203;(<a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role">SelectUserParam</a>&nbsp;requestParam)</pre>
  1901. <div class="block">Get all roles the user has.</div>
  1902. <dl>
  1903. <dt><span class="paramLabel">Parameters:</span></dt>
  1904. <dd><code>requestParam</code> - <a href="../param/role/SelectUserParam.html" title="class in io.milvus.param.role"><code>SelectUserParam</code></a></dd>
  1905. <dt><span class="returnLabel">Returns:</span></dt>
  1906. <dd>{status:result code, data:SelectUserResponse{status,info}}</dd>
  1907. </dl>
  1908. </li>
  1909. </ul>
  1910. <a id="grantRolePrivilege(io.milvus.param.role.GrantRolePrivilegeParam)">
  1911. <!-- -->
  1912. </a>
  1913. <ul class="blockList">
  1914. <li class="blockList">
  1915. <h4>grantRolePrivilege</h4>
  1916. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;grantRolePrivilege&#8203;(<a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role">GrantRolePrivilegeParam</a>&nbsp;requestParam)</pre>
  1917. <div class="block">Grant Role Privilege.</div>
  1918. <dl>
  1919. <dt><span class="paramLabel">Parameters:</span></dt>
  1920. <dd><code>requestParam</code> - <a href="../param/role/GrantRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>GrantRolePrivilegeParam</code></a></dd>
  1921. <dt><span class="returnLabel">Returns:</span></dt>
  1922. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1923. </dl>
  1924. </li>
  1925. </ul>
  1926. <a id="revokeRolePrivilege(io.milvus.param.role.RevokeRolePrivilegeParam)">
  1927. <!-- -->
  1928. </a>
  1929. <ul class="blockList">
  1930. <li class="blockList">
  1931. <h4>revokeRolePrivilege</h4>
  1932. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;revokeRolePrivilege&#8203;(<a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role">RevokeRolePrivilegeParam</a>&nbsp;requestParam)</pre>
  1933. <div class="block">Revoke Role Privilege.</div>
  1934. <dl>
  1935. <dt><span class="paramLabel">Parameters:</span></dt>
  1936. <dd><code>requestParam</code> - <a href="../param/role/RevokeRolePrivilegeParam.html" title="class in io.milvus.param.role"><code>RevokeRolePrivilegeParam</code></a></dd>
  1937. <dt><span class="returnLabel">Returns:</span></dt>
  1938. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  1939. </dl>
  1940. </li>
  1941. </ul>
  1942. <a id="selectGrantForRole(io.milvus.param.role.SelectGrantForRoleParam)">
  1943. <!-- -->
  1944. </a>
  1945. <ul class="blockList">
  1946. <li class="blockList">
  1947. <h4>selectGrantForRole</h4>
  1948. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;&nbsp;selectGrantForRole&#8203;(<a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role">SelectGrantForRoleParam</a>&nbsp;requestParam)</pre>
  1949. <div class="block">List a grant info for the role and the specific object</div>
  1950. <dl>
  1951. <dt><span class="paramLabel">Parameters:</span></dt>
  1952. <dd><code>requestParam</code> - <a href="../param/role/SelectGrantForRoleParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleParam</code></a></dd>
  1953. <dt><span class="returnLabel">Returns:</span></dt>
  1954. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  1955. </dl>
  1956. </li>
  1957. </ul>
  1958. <a id="selectGrantForRoleAndObject(io.milvus.param.role.SelectGrantForRoleAndObjectParam)">
  1959. <!-- -->
  1960. </a>
  1961. <ul class="blockList">
  1962. <li class="blockList">
  1963. <h4>selectGrantForRoleAndObject</h4>
  1964. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.SelectGrantResponse&gt;&nbsp;selectGrantForRoleAndObject&#8203;(<a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role">SelectGrantForRoleAndObjectParam</a>&nbsp;requestParam)</pre>
  1965. <div class="block">List a grant info for the role</div>
  1966. <dl>
  1967. <dt><span class="paramLabel">Parameters:</span></dt>
  1968. <dd><code>requestParam</code> - <a href="../param/role/SelectGrantForRoleAndObjectParam.html" title="class in io.milvus.param.role"><code>SelectGrantForRoleAndObjectParam</code></a></dd>
  1969. <dt><span class="returnLabel">Returns:</span></dt>
  1970. <dd>{status:result code, data:SelectRoleResponse{status,info}}</dd>
  1971. </dl>
  1972. </li>
  1973. </ul>
  1974. <a id="bulkInsert(io.milvus.param.bulkinsert.BulkInsertParam)">
  1975. <!-- -->
  1976. </a>
  1977. <ul class="blockList">
  1978. <li class="blockList">
  1979. <h4>bulkInsert</h4>
  1980. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ImportResponse&gt;&nbsp;bulkInsert&#8203;(<a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert">BulkInsertParam</a>&nbsp;requestParam)</pre>
  1981. <div class="block">Import data from external files, currently support JSON format</div>
  1982. <dl>
  1983. <dt><span class="paramLabel">Parameters:</span></dt>
  1984. <dd><code>requestParam</code> - <a href="../param/bulkinsert/BulkInsertParam.html" title="class in io.milvus.param.bulkinsert"><code>BulkInsertParam</code></a></dd>
  1985. <dt><span class="returnLabel">Returns:</span></dt>
  1986. <dd>{status:result code, data:ImportResponse{status,info}}</dd>
  1987. </dl>
  1988. </li>
  1989. </ul>
  1990. <a id="getBulkInsertState(io.milvus.param.bulkinsert.GetBulkInsertStateParam)">
  1991. <!-- -->
  1992. </a>
  1993. <ul class="blockList">
  1994. <li class="blockList">
  1995. <h4>getBulkInsertState</h4>
  1996. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetImportStateResponse&gt;&nbsp;getBulkInsertState&#8203;(<a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert">GetBulkInsertStateParam</a>&nbsp;requestParam)</pre>
  1997. <div class="block">Get state of bulk insert task</div>
  1998. <dl>
  1999. <dt><span class="paramLabel">Parameters:</span></dt>
  2000. <dd><code>requestParam</code> - <a href="../param/bulkinsert/GetBulkInsertStateParam.html" title="class in io.milvus.param.bulkinsert"><code>GetBulkInsertStateParam</code></a></dd>
  2001. <dt><span class="returnLabel">Returns:</span></dt>
  2002. <dd>{status:result code, data:GetImportStateResponse{status,info}}</dd>
  2003. </dl>
  2004. </li>
  2005. </ul>
  2006. <a id="listBulkInsertTasks(io.milvus.param.bulkinsert.ListBulkInsertTasksParam)">
  2007. <!-- -->
  2008. </a>
  2009. <ul class="blockList">
  2010. <li class="blockList">
  2011. <h4>listBulkInsertTasks</h4>
  2012. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListImportTasksResponse&gt;&nbsp;listBulkInsertTasks&#8203;(<a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert">ListBulkInsertTasksParam</a>&nbsp;requestParam)</pre>
  2013. <div class="block">List bulk insert tasks</div>
  2014. <dl>
  2015. <dt><span class="paramLabel">Parameters:</span></dt>
  2016. <dd><code>requestParam</code> - <a href="../param/bulkinsert/ListBulkInsertTasksParam.html" title="class in io.milvus.param.bulkinsert"><code>ListBulkInsertTasksParam</code></a></dd>
  2017. <dt><span class="returnLabel">Returns:</span></dt>
  2018. <dd>{status:result code, data:ListImportTasksResponse{status,info}}</dd>
  2019. </dl>
  2020. </li>
  2021. </ul>
  2022. <a id="checkHealth()">
  2023. <!-- -->
  2024. </a>
  2025. <ul class="blockList">
  2026. <li class="blockList">
  2027. <h4>checkHealth</h4>
  2028. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.CheckHealthResponse&gt;&nbsp;checkHealth()</pre>
  2029. <div class="block">Check server health</div>
  2030. <dl>
  2031. <dt><span class="returnLabel">Returns:</span></dt>
  2032. <dd>{status:result code, data:CheckHealthResponse{status,info}}</dd>
  2033. </dl>
  2034. </li>
  2035. </ul>
  2036. <a id="getVersion()">
  2037. <!-- -->
  2038. </a>
  2039. <ul class="blockList">
  2040. <li class="blockList">
  2041. <h4>getVersion</h4>
  2042. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetVersionResponse&gt;&nbsp;getVersion()</pre>
  2043. <div class="block">Get server version</div>
  2044. <dl>
  2045. <dt><span class="returnLabel">Returns:</span></dt>
  2046. <dd>{status:result code, data:GetVersionResponse{status,info}}</dd>
  2047. </dl>
  2048. </li>
  2049. </ul>
  2050. <a id="getLoadingProgress(io.milvus.param.collection.GetLoadingProgressParam)">
  2051. <!-- -->
  2052. </a>
  2053. <ul class="blockList">
  2054. <li class="blockList">
  2055. <h4>getLoadingProgress</h4>
  2056. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadingProgressResponse&gt;&nbsp;getLoadingProgress&#8203;(<a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection">GetLoadingProgressParam</a>&nbsp;requestParam)</pre>
  2057. <div class="block">Get collection loading progress</div>
  2058. <dl>
  2059. <dt><span class="paramLabel">Parameters:</span></dt>
  2060. <dd><code>requestParam</code> - <a href="../param/collection/GetLoadingProgressParam.html" title="class in io.milvus.param.collection"><code>GetLoadingProgressParam</code></a></dd>
  2061. <dt><span class="returnLabel">Returns:</span></dt>
  2062. <dd>{status:result code, data:GetLoadingProgressResponse{status}}</dd>
  2063. </dl>
  2064. </li>
  2065. </ul>
  2066. <a id="getLoadState(io.milvus.param.collection.GetLoadStateParam)">
  2067. <!-- -->
  2068. </a>
  2069. <ul class="blockList">
  2070. <li class="blockList">
  2071. <h4>getLoadState</h4>
  2072. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.GetLoadStateResponse&gt;&nbsp;getLoadState&#8203;(<a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection">GetLoadStateParam</a>&nbsp;requestParam)</pre>
  2073. <div class="block">Get collection loading state</div>
  2074. <dl>
  2075. <dt><span class="paramLabel">Parameters:</span></dt>
  2076. <dd><code>requestParam</code> - <a href="../param/collection/GetLoadStateParam.html" title="class in io.milvus.param.collection"><code>GetLoadStateParam</code></a></dd>
  2077. <dt><span class="returnLabel">Returns:</span></dt>
  2078. <dd>{status:result code, data:GetLoadStateResponse{status}}</dd>
  2079. </dl>
  2080. </li>
  2081. </ul>
  2082. <a id="createResourceGroup(io.milvus.param.resourcegroup.CreateResourceGroupParam)">
  2083. <!-- -->
  2084. </a>
  2085. <ul class="blockList">
  2086. <li class="blockList">
  2087. <h4>createResourceGroup</h4>
  2088. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createResourceGroup&#8203;(<a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">CreateResourceGroupParam</a>&nbsp;requestParam)</pre>
  2089. <div class="block">Create a resource group.</div>
  2090. <dl>
  2091. <dt><span class="paramLabel">Parameters:</span></dt>
  2092. <dd><code>requestParam</code> - <a href="../param/resourcegroup/CreateResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>CreateResourceGroupParam</code></a></dd>
  2093. <dt><span class="returnLabel">Returns:</span></dt>
  2094. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2095. </dl>
  2096. </li>
  2097. </ul>
  2098. <a id="dropResourceGroup(io.milvus.param.resourcegroup.DropResourceGroupParam)">
  2099. <!-- -->
  2100. </a>
  2101. <ul class="blockList">
  2102. <li class="blockList">
  2103. <h4>dropResourceGroup</h4>
  2104. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;dropResourceGroup&#8203;(<a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DropResourceGroupParam</a>&nbsp;requestParam)</pre>
  2105. <div class="block">Drop a resource group.</div>
  2106. <dl>
  2107. <dt><span class="paramLabel">Parameters:</span></dt>
  2108. <dd><code>requestParam</code> - <a href="../param/resourcegroup/DropResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DropResourceGroupParam</code></a></dd>
  2109. <dt><span class="returnLabel">Returns:</span></dt>
  2110. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2111. </dl>
  2112. </li>
  2113. </ul>
  2114. <a id="listResourceGroups(io.milvus.param.resourcegroup.ListResourceGroupsParam)">
  2115. <!-- -->
  2116. </a>
  2117. <ul class="blockList">
  2118. <li class="blockList">
  2119. <h4>listResourceGroups</h4>
  2120. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.ListResourceGroupsResponse&gt;&nbsp;listResourceGroups&#8203;(<a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup">ListResourceGroupsParam</a>&nbsp;requestParam)</pre>
  2121. <div class="block">List resource groups.</div>
  2122. <dl>
  2123. <dt><span class="paramLabel">Parameters:</span></dt>
  2124. <dd><code>requestParam</code> - <a href="../param/resourcegroup/ListResourceGroupsParam.html" title="class in io.milvus.param.resourcegroup"><code>ListResourceGroupsParam</code></a></dd>
  2125. <dt><span class="returnLabel">Returns:</span></dt>
  2126. <dd>{status:result code, data:ListResourceGroupsResponse{status}}</dd>
  2127. </dl>
  2128. </li>
  2129. </ul>
  2130. <a id="describeResourceGroup(io.milvus.param.resourcegroup.DescribeResourceGroupParam)">
  2131. <!-- -->
  2132. </a>
  2133. <ul class="blockList">
  2134. <li class="blockList">
  2135. <h4>describeResourceGroup</h4>
  2136. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;io.milvus.grpc.DescribeResourceGroupResponse&gt;&nbsp;describeResourceGroup&#8203;(<a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup">DescribeResourceGroupParam</a>&nbsp;requestParam)</pre>
  2137. <div class="block">Describe a resource group.</div>
  2138. <dl>
  2139. <dt><span class="paramLabel">Parameters:</span></dt>
  2140. <dd><code>requestParam</code> - <a href="../param/resourcegroup/DescribeResourceGroupParam.html" title="class in io.milvus.param.resourcegroup"><code>DescribeResourceGroupParam</code></a></dd>
  2141. <dt><span class="returnLabel">Returns:</span></dt>
  2142. <dd>{status:result code, data:DescribeResourceGroupResponse{status}}</dd>
  2143. </dl>
  2144. </li>
  2145. </ul>
  2146. <a id="transferNode(io.milvus.param.resourcegroup.TransferNodeParam)">
  2147. <!-- -->
  2148. </a>
  2149. <ul class="blockList">
  2150. <li class="blockList">
  2151. <h4>transferNode</h4>
  2152. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;transferNode&#8203;(<a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup">TransferNodeParam</a>&nbsp;requestParam)</pre>
  2153. <div class="block">Transfer a query node from source resource group to target resource_group.</div>
  2154. <dl>
  2155. <dt><span class="paramLabel">Parameters:</span></dt>
  2156. <dd><code>requestParam</code> - <a href="../param/resourcegroup/TransferNodeParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferNodeParam</code></a></dd>
  2157. <dt><span class="returnLabel">Returns:</span></dt>
  2158. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2159. </dl>
  2160. </li>
  2161. </ul>
  2162. <a id="transferReplica(io.milvus.param.resourcegroup.TransferReplicaParam)">
  2163. <!-- -->
  2164. </a>
  2165. <ul class="blockList">
  2166. <li class="blockList">
  2167. <h4>transferReplica</h4>
  2168. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;transferReplica&#8203;(<a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup">TransferReplicaParam</a>&nbsp;requestParam)</pre>
  2169. <div class="block">Transfer a replica from source resource group to target resource_group.</div>
  2170. <dl>
  2171. <dt><span class="paramLabel">Parameters:</span></dt>
  2172. <dd><code>requestParam</code> - <a href="../param/resourcegroup/TransferReplicaParam.html" title="class in io.milvus.param.resourcegroup"><code>TransferReplicaParam</code></a></dd>
  2173. <dt><span class="returnLabel">Returns:</span></dt>
  2174. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2175. </dl>
  2176. </li>
  2177. </ul>
  2178. <a id="createCollection(io.milvus.param.highlevel.collection.CreateSimpleCollectionParam)">
  2179. <!-- -->
  2180. </a>
  2181. <ul class="blockList">
  2182. <li class="blockList">
  2183. <h4>createCollection</h4>
  2184. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>&gt;&nbsp;createCollection&#8203;(<a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection">CreateSimpleCollectionParam</a>&nbsp;requestParam)</pre>
  2185. <div class="block">Creates a collection in Milvus.</div>
  2186. <dl>
  2187. <dt><span class="paramLabel">Parameters:</span></dt>
  2188. <dd><code>requestParam</code> - <a href="../param/highlevel/collection/CreateSimpleCollectionParam.html" title="class in io.milvus.param.highlevel.collection"><code>CreateSimpleCollectionParam</code></a></dd>
  2189. <dt><span class="returnLabel">Returns:</span></dt>
  2190. <dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
  2191. </dl>
  2192. </li>
  2193. </ul>
  2194. <a id="listCollections(io.milvus.param.highlevel.collection.ListCollectionsParam)">
  2195. <!-- -->
  2196. </a>
  2197. <ul class="blockList">
  2198. <li class="blockList">
  2199. <h4>listCollections</h4>
  2200. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/collection/response/ListCollectionsResponse.html" title="class in io.milvus.param.highlevel.collection.response">ListCollectionsResponse</a>&gt;&nbsp;listCollections&#8203;(<a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection">ListCollectionsParam</a>&nbsp;requestParam)</pre>
  2201. <div class="block">Lists all collections</div>
  2202. <dl>
  2203. <dt><span class="paramLabel">Parameters:</span></dt>
  2204. <dd><code>requestParam</code> - <a href="../param/highlevel/collection/ListCollectionsParam.html" title="class in io.milvus.param.highlevel.collection"><code>ListCollectionsParam</code></a></dd>
  2205. <dt><span class="returnLabel">Returns:</span></dt>
  2206. <dd>{status:result code, data: ListCollectionsResponse{collection_names}}</dd>
  2207. </dl>
  2208. </li>
  2209. </ul>
  2210. <a id="insert(io.milvus.param.highlevel.dml.InsertRowsParam)">
  2211. <!-- -->
  2212. </a>
  2213. <ul class="blockList">
  2214. <li class="blockList">
  2215. <h4>insert</h4>
  2216. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/InsertResponse.html" title="class in io.milvus.param.highlevel.dml.response">InsertResponse</a>&gt;&nbsp;insert&#8203;(<a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml">InsertRowsParam</a>&nbsp;requestParam)</pre>
  2217. <div class="block">Inserts rows data into a specified collection . Note that you don't need to
  2218. input primary key field if auto_id is enabled.</div>
  2219. <dl>
  2220. <dt><span class="paramLabel">Parameters:</span></dt>
  2221. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/InsertRowsParam.html" title="class in io.milvus.param.highlevel.dml"><code>InsertRowsParam</code></a></dd>
  2222. <dt><span class="returnLabel">Returns:</span></dt>
  2223. <dd>{status:result code, data: MutationResult{insert results}}</dd>
  2224. </dl>
  2225. </li>
  2226. </ul>
  2227. <a id="delete(io.milvus.param.highlevel.dml.DeleteIdsParam)">
  2228. <!-- -->
  2229. </a>
  2230. <ul class="blockList">
  2231. <li class="blockList">
  2232. <h4>delete</h4>
  2233. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/DeleteResponse.html" title="class in io.milvus.param.highlevel.dml.response">DeleteResponse</a>&gt;&nbsp;delete&#8203;(<a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml">DeleteIdsParam</a>&nbsp;requestParam)</pre>
  2234. <div class="block">Deletes entity(s) based on the value of primary key.</div>
  2235. <dl>
  2236. <dt><span class="paramLabel">Parameters:</span></dt>
  2237. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/DeleteIdsParam.html" title="class in io.milvus.param.highlevel.dml"><code>DeleteIdsParam</code></a></dd>
  2238. <dt><span class="returnLabel">Returns:</span></dt>
  2239. <dd>{status:result code, data: MutationResult{delete results}}</dd>
  2240. </dl>
  2241. </li>
  2242. </ul>
  2243. <a id="get(io.milvus.param.highlevel.dml.GetIdsParam)">
  2244. <!-- -->
  2245. </a>
  2246. <ul class="blockList">
  2247. <li class="blockList">
  2248. <h4>get</h4>
  2249. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/GetResponse.html" title="class in io.milvus.param.highlevel.dml.response">GetResponse</a>&gt;&nbsp;get&#8203;(<a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml">GetIdsParam</a>&nbsp;requestParam)</pre>
  2250. <div class="block">Get entity(s) based on the value of primary key.</div>
  2251. <dl>
  2252. <dt><span class="paramLabel">Parameters:</span></dt>
  2253. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/GetIdsParam.html" title="class in io.milvus.param.highlevel.dml"><code>GetIdsParam</code></a></dd>
  2254. <dt><span class="returnLabel">Returns:</span></dt>
  2255. <dd>{status:result code, data: QueryResults{query results}}</dd>
  2256. </dl>
  2257. </li>
  2258. </ul>
  2259. <a id="query(io.milvus.param.highlevel.dml.QuerySimpleParam)">
  2260. <!-- -->
  2261. </a>
  2262. <ul class="blockList">
  2263. <li class="blockList">
  2264. <h4>query</h4>
  2265. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/QueryResponse.html" title="class in io.milvus.param.highlevel.dml.response">QueryResponse</a>&gt;&nbsp;query&#8203;(<a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml">QuerySimpleParam</a>&nbsp;requestParam)</pre>
  2266. <div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
  2267. Note that the order of the returned entities cannot be guaranteed.</div>
  2268. <dl>
  2269. <dt><span class="paramLabel">Parameters:</span></dt>
  2270. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/QuerySimpleParam.html" title="class in io.milvus.param.highlevel.dml"><code>QuerySimpleParam</code></a></dd>
  2271. <dt><span class="returnLabel">Returns:</span></dt>
  2272. <dd>{status:result code,data: QueryResults{filter results}}</dd>
  2273. </dl>
  2274. </li>
  2275. </ul>
  2276. <a id="search(io.milvus.param.highlevel.dml.SearchSimpleParam)">
  2277. <!-- -->
  2278. </a>
  2279. <ul class="blockList">
  2280. <li class="blockList">
  2281. <h4>search</h4>
  2282. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../param/highlevel/dml/response/SearchResponse.html" title="class in io.milvus.param.highlevel.dml.response">SearchResponse</a>&gt;&nbsp;search&#8203;(<a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml">SearchSimpleParam</a>&nbsp;requestParam)</pre>
  2283. <div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
  2284. <dl>
  2285. <dt><span class="paramLabel">Parameters:</span></dt>
  2286. <dd><code>requestParam</code> - <a href="../param/highlevel/dml/SearchSimpleParam.html" title="class in io.milvus.param.highlevel.dml"><code>SearchSimpleParam</code></a></dd>
  2287. <dt><span class="returnLabel">Returns:</span></dt>
  2288. <dd>{status:result code, data: SearchResults{topK results}}</dd>
  2289. </dl>
  2290. </li>
  2291. </ul>
  2292. <a id="queryIterator(io.milvus.param.dml.QueryIteratorParam)">
  2293. <!-- -->
  2294. </a>
  2295. <ul class="blockList">
  2296. <li class="blockList">
  2297. <h4>queryIterator</h4>
  2298. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/QueryIterator.html" title="class in io.milvus.orm.iterator">QueryIterator</a>&gt;&nbsp;queryIterator&#8203;(<a href="../param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml">QueryIteratorParam</a>&nbsp;requestParam)</pre>
  2299. <div class="block">Get queryIterator based on scalar field(s) filtered by boolean expression.
  2300. Note that the order of the returned entities cannot be guaranteed.</div>
  2301. <dl>
  2302. <dt><span class="paramLabel">Parameters:</span></dt>
  2303. <dd><code>requestParam</code> - <a href="../param/dml/QueryIteratorParam.html" title="class in io.milvus.param.dml"><code>QueryIteratorParam</code></a></dd>
  2304. <dt><span class="returnLabel">Returns:</span></dt>
  2305. <dd>{status:result code,data: QueryIterator}</dd>
  2306. </dl>
  2307. </li>
  2308. </ul>
  2309. <a id="searchIterator(io.milvus.param.dml.SearchIteratorParam)">
  2310. <!-- -->
  2311. </a>
  2312. <ul class="blockListLast">
  2313. <li class="blockList">
  2314. <h4>searchIterator</h4>
  2315. <pre class="methodSignature"><a href="../param/R.html" title="class in io.milvus.param">R</a>&lt;<a href="../orm/iterator/SearchIterator.html" title="class in io.milvus.orm.iterator">SearchIterator</a>&gt;&nbsp;searchIterator&#8203;(<a href="../param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml">SearchIteratorParam</a>&nbsp;requestParam)</pre>
  2316. <div class="block">Get searchIterator based on a vector field. Use expression to do filtering before search.</div>
  2317. <dl>
  2318. <dt><span class="paramLabel">Parameters:</span></dt>
  2319. <dd><code>requestParam</code> - <a href="../param/dml/SearchIteratorParam.html" title="class in io.milvus.param.dml"><code>SearchIteratorParam</code></a></dd>
  2320. <dt><span class="returnLabel">Returns:</span></dt>
  2321. <dd>{status:result code, data: SearchIterator}</dd>
  2322. </dl>
  2323. </li>
  2324. </ul>
  2325. </li>
  2326. </ul>
  2327. </section>
  2328. </li>
  2329. </ul>
  2330. </div>
  2331. </div>
  2332. </main>
  2333. <!-- ========= END OF CLASS DATA ========= -->
  2334. <footer role="contentinfo">
  2335. <nav role="navigation">
  2336. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  2337. <div class="bottomNav"><a id="navbar.bottom">
  2338. <!-- -->
  2339. </a>
  2340. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  2341. <a id="navbar.bottom.firstrow">
  2342. <!-- -->
  2343. </a>
  2344. <ul class="navList" title="Navigation">
  2345. <li><a href="../../../index.html">Overview</a></li>
  2346. <li><a href="package-summary.html">Package</a></li>
  2347. <li class="navBarCell1Rev">Class</li>
  2348. <li><a href="package-tree.html">Tree</a></li>
  2349. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  2350. <li><a href="../../../index-files/index-1.html">Index</a></li>
  2351. <li><a href="../../../help-doc.html">Help</a></li>
  2352. </ul>
  2353. </div>
  2354. <div class="subNav">
  2355. <ul class="navList" id="allclasses_navbar_bottom">
  2356. <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
  2357. </ul>
  2358. <div>
  2359. <script type="text/javascript"><!--
  2360. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  2361. if(window==top) {
  2362. allClassesLink.style.display = "block";
  2363. }
  2364. else {
  2365. allClassesLink.style.display = "none";
  2366. }
  2367. //-->
  2368. </script>
  2369. <noscript>
  2370. <div>JavaScript is disabled on your browser.</div>
  2371. </noscript>
  2372. </div>
  2373. <div>
  2374. <ul class="subNavList">
  2375. <li>Summary:&nbsp;</li>
  2376. <li>Nested&nbsp;|&nbsp;</li>
  2377. <li>Field&nbsp;|&nbsp;</li>
  2378. <li>Constr&nbsp;|&nbsp;</li>
  2379. <li><a href="#method.summary">Method</a></li>
  2380. </ul>
  2381. <ul class="subNavList">
  2382. <li>Detail:&nbsp;</li>
  2383. <li>Field&nbsp;|&nbsp;</li>
  2384. <li>Constr&nbsp;|&nbsp;</li>
  2385. <li><a href="#method.detail">Method</a></li>
  2386. </ul>
  2387. </div>
  2388. <a id="skip.navbar.bottom">
  2389. <!-- -->
  2390. </a></div>
  2391. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  2392. </nav>
  2393. </footer>
  2394. </body>
  2395. </html>