|
@@ -0,0 +1,1552 @@
|
|
|
+<!DOCTYPE HTML>
|
|
|
+<!-- NewPage -->
|
|
|
+<html lang="en">
|
|
|
+<head>
|
|
|
+<!-- Generated by javadoc (11.0.15) on Mon Jul 11 18:29:45 CST 2022 -->
|
|
|
+<title>MilvusMultiServiceClient</title>
|
|
|
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
+<meta name="dc.created" content="2022-07-11">
|
|
|
+<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
|
+<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
|
|
|
+<script type="text/javascript" src="../../../script.js"></script>
|
|
|
+<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
|
+<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
|
+<!--[if IE]>
|
|
|
+<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
|
+<![endif]-->
|
|
|
+<script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
|
|
|
+<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
|
|
|
+</head>
|
|
|
+<body>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+ try {
|
|
|
+ if (location.href.indexOf('is-external=true') == -1) {
|
|
|
+ parent.document.title="MilvusMultiServiceClient";
|
|
|
+ }
|
|
|
+ }
|
|
|
+ catch(err) {
|
|
|
+ }
|
|
|
+//-->
|
|
|
+var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10};
|
|
|
+var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
|
+var altColor = "altColor";
|
|
|
+var rowColor = "rowColor";
|
|
|
+var tableTab = "tableTab";
|
|
|
+var activeTableTab = "activeTableTab";
|
|
|
+var pathtoroot = "../../../";
|
|
|
+var useModuleDirectories = true;
|
|
|
+loadScripts(document, 'script');</script>
|
|
|
+<noscript>
|
|
|
+<div>JavaScript is disabled on your browser.</div>
|
|
|
+</noscript>
|
|
|
+<header role="banner">
|
|
|
+<nav role="navigation">
|
|
|
+<div class="fixedNav">
|
|
|
+<!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
+<div class="topNav"><a id="navbar.top">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
|
+<a id="navbar.top.firstrow">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="navList" title="Navigation">
|
|
|
+<li><a href="../../../index.html">Overview</a></li>
|
|
|
+<li><a href="package-summary.html">Package</a></li>
|
|
|
+<li class="navBarCell1Rev">Class</li>
|
|
|
+<li><a href="package-tree.html">Tree</a></li>
|
|
|
+<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
|
+<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
|
+<li><a href="../../../help-doc.html">Help</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="subNav">
|
|
|
+<ul class="navList" id="allclasses_navbar_top">
|
|
|
+<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="navListSearch">
|
|
|
+<li><label for="search">SEARCH:</label>
|
|
|
+<input type="text" id="search" value="search" disabled="disabled">
|
|
|
+<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<div>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+ allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
|
+ if(window==top) {
|
|
|
+ allClassesLink.style.display = "block";
|
|
|
+ }
|
|
|
+ else {
|
|
|
+ allClassesLink.style.display = "none";
|
|
|
+ }
|
|
|
+ //-->
|
|
|
+</script>
|
|
|
+<noscript>
|
|
|
+<div>JavaScript is disabled on your browser.</div>
|
|
|
+</noscript>
|
|
|
+</div>
|
|
|
+<div>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Summary: </li>
|
|
|
+<li>Nested | </li>
|
|
|
+<li>Field | </li>
|
|
|
+<li><a href="#constructor.summary">Constr</a> | </li>
|
|
|
+<li><a href="#method.summary">Method</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Detail: </li>
|
|
|
+<li>Field | </li>
|
|
|
+<li><a href="#constructor.detail">Constr</a> | </li>
|
|
|
+<li><a href="#method.detail">Method</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<a id="skip.navbar.top">
|
|
|
+<!-- -->
|
|
|
+</a></div>
|
|
|
+<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
+</div>
|
|
|
+<div class="navPadding"> </div>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
|
+//-->
|
|
|
+</script>
|
|
|
+</nav>
|
|
|
+</header>
|
|
|
+<!-- ======== START OF CLASS DATA ======== -->
|
|
|
+<main role="main">
|
|
|
+<div class="header">
|
|
|
+<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">io.milvus.client</a></div>
|
|
|
+<h2 title="Class MilvusMultiServiceClient" class="title">Class MilvusMultiServiceClient</h2>
|
|
|
+</div>
|
|
|
+<div class="contentContainer">
|
|
|
+<ul class="inheritance">
|
|
|
+<li>java.lang.Object</li>
|
|
|
+<li>
|
|
|
+<ul class="inheritance">
|
|
|
+<li>io.milvus.client.MilvusMultiServiceClient</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<div class="description">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<dl>
|
|
|
+<dt>All Implemented Interfaces:</dt>
|
|
|
+<dd><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+</dl>
|
|
|
+<hr>
|
|
|
+<pre>public class <span class="typeNameLabel">MilvusMultiServiceClient</span>
|
|
|
+extends java.lang.Object
|
|
|
+implements <a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></pre>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="summary">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
+<section role="region">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a id="constructor.summary">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Constructor Summary</h3>
|
|
|
+<table class="memberSummary">
|
|
|
+<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
|
+<tr>
|
|
|
+<th class="colFirst" scope="col">Constructor</th>
|
|
|
+<th class="colLast" scope="col">Description</th>
|
|
|
+</tr>
|
|
|
+<tr class="altColor">
|
|
|
+<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(io.milvus.param.MultiConnectParam)">MilvusMultiServiceClient</a></span>​(@NonNull <a href="../param/MultiConnectParam.html" title="class in io.milvus.param">MultiConnectParam</a> multiConnectParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Sets connect param for multi milvus clusters.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+</table>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</section>
|
|
|
+<!-- ========== METHOD SUMMARY =========== -->
|
|
|
+<section role="region">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a id="method.summary">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Method Summary</h3>
|
|
|
+<table class="memberSummary">
|
|
|
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
|
+<tr>
|
|
|
+<th class="colFirst" scope="col">Modifier and Type</th>
|
|
|
+<th class="colSecond" scope="col">Method</th>
|
|
|
+<th class="colLast" scope="col">Description</th>
|
|
|
+</tr>
|
|
|
+<tr id="i0" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></span>​(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Alters alias from a collection to another.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i1" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.CalcDistanceResults></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#calcDistance(io.milvus.param.dml.CalcDistanceParam)">calcDistance</a></span>​(<a href="../param/dml/CalcDistanceParam.html" title="class in io.milvus.param.dml">CalcDistanceParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Calculates the distance between the specified vectors.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i2" class="altColor">
|
|
|
+<td class="colFirst"><code>void</code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(long)">close</a></span>​(long maxWaitSeconds)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Disconnects from a Milvus server with configurable timeout.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i3" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></span>​(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Creates an alias for a collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i4" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></span>​(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Creates a collection in Milvus.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i5" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></span>​(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Create credential using the given user and password.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i6" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></span>​(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Creates an index on a vector field in the specified collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i7" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></span>​(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Creates a partition in the specified collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i8" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete(io.milvus.param.dml.DeleteParam)">delete</a></span>​(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i9" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></span>​(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Delete credential corresponding to the user.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i10" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></span>​(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows the details of a collection, e.g.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i11" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></span>​(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows the information of the specified index.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i12" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></span>​(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Drops an alias for the specified collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i13" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></span>​(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Drops a collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i14" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></span>​(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Drops the index on a vector field in the specified collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i15" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></span>​(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Drops a partition.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i16" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flush(io.milvus.param.collection.FlushParam)">flush</a></span>​(<a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Flushes collections.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i17" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></span>​(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows the statistics information of a collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i18" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></span>​(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Gets the compaction state by id.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i19" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></span>​(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Gets compaction state with its plan.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i20" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></span>​(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Get flush state of specified segments.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i21" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></span>​(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows the index building progress, such as how many rows are indexed.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i22" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></span>​(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i23" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></span>​(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i24" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></span>​(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows the statistics information of a partition.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i25" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></span>​(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Gets the information of persistent segments from data node, including row count,
|
|
|
+ persistence state(growing or flushed), etc.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i26" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></span>​(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Gets the query information of segments in a collection from query node, including row count,
|
|
|
+ memory usage size, index name, etc.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i27" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></span>​(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Returns the collection's replica information</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i28" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></span>​(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Checks if a collection exists.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i29" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></span>​(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Checks if a partition exists in the specified collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i30" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insert(io.milvus.param.dml.InsertParam)">insert</a></span>​(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Inserts entities into a specified collection .</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i31" class="rowColor">
|
|
|
+<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></span>​(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Inserts entities into a specified collection asynchronously.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i32" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></span>​(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">List all user names.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i33" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></span>​(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Moves segment from a query node to another to keep the load balanced.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i34" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></span>​(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Loads a collection to memory before search or query.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i35" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></span>​(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Loads a partition into memory.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i36" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#manualCompaction(io.milvus.param.control.ManualCompactionParam)">manualCompaction</a></span>​(<a href="../param/control/ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Performs a manual compaction.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i37" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#query(io.milvus.param.dml.QueryParam)">query</a></span>​(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i38" class="altColor">
|
|
|
+<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></span>​(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i39" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></span>​(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Releases a collection from memory to reduce memory usage.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i40" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></span>​(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Releases a partition from memory.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i41" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#search(io.milvus.param.dml.SearchParam)">search</a></span>​(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Conducts ANN search on a vector field.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i42" class="altColor">
|
|
|
+<td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></span>​(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Conducts ANN search on a vector field asynchronously.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i43" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></span>​(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Lists all collections or gets collection loading status.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i44" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></span>​(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Shows all partitions in the specified collection.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i45" class="rowColor">
|
|
|
+<td class="colFirst"><code><a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></span>​(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a> requestParam)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Update credential using the given user and password.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+<tr id="i46" class="altColor">
|
|
|
+<td class="colFirst"><code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></td>
|
|
|
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></span>​(long timeout,
|
|
|
+ java.util.concurrent.TimeUnit timeoutUnit)</code></th>
|
|
|
+<td class="colLast">
|
|
|
+<div class="block">Timeout setting for rpc call.</div>
|
|
|
+</td>
|
|
|
+</tr>
|
|
|
+</table>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Methods inherited from class java.lang.Object</h3>
|
|
|
+<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
|
+</ul>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a id="methods.inherited.from.class.io.milvus.client.MilvusClient">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Methods inherited from interface io.milvus.client.<a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></h3>
|
|
|
+<code><a href="MilvusClient.html#close()">close</a></code></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</section>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="details">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
+<section role="region">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a id="constructor.detail">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Constructor Detail</h3>
|
|
|
+<a id="<init>(io.milvus.param.MultiConnectParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockListLast">
|
|
|
+<li class="blockList">
|
|
|
+<h4>MilvusMultiServiceClient</h4>
|
|
|
+<pre>public MilvusMultiServiceClient​(@NonNull
|
|
|
+ @NonNull <a href="../param/MultiConnectParam.html" title="class in io.milvus.param">MultiConnectParam</a> multiConnectParam)</pre>
|
|
|
+<div class="block">Sets connect param for multi milvus clusters.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>multiConnectParam</code> - multi server connect param</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</section>
|
|
|
+<!-- ============ METHOD DETAIL ========== -->
|
|
|
+<section role="region">
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList"><a id="method.detail">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<h3>Method Detail</h3>
|
|
|
+<a id="withTimeout(long,java.util.concurrent.TimeUnit)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>withTimeout</h4>
|
|
|
+<pre class="methodSignature">public <a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a> withTimeout​(long timeout,
|
|
|
+ java.util.concurrent.TimeUnit timeoutUnit)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#withTimeout(long,java.util.concurrent.TimeUnit)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Timeout setting for rpc call.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#withTimeout(long,java.util.concurrent.TimeUnit)">withTimeout</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>timeout</code> - set time waiting for a rpc call.</dd>
|
|
|
+<dd><code>timeoutUnit</code> - time unit</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="close(long)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>close</h4>
|
|
|
+<pre class="methodSignature">public void close​(long maxWaitSeconds)
|
|
|
+ throws java.lang.InterruptedException</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#close(long)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Disconnects from a Milvus server with configurable timeout.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#close(long)">close</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>maxWaitSeconds</code> - timeout unit: second</dd>
|
|
|
+<dt><span class="throwsLabel">Throws:</span></dt>
|
|
|
+<dd><code>java.lang.InterruptedException</code></dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="hasCollection(io.milvus.param.collection.HasCollectionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>hasCollection</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean> hasCollection​(<a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection">HasCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#hasCollection(io.milvus.param.collection.HasCollectionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Checks if a collection exists.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#hasCollection(io.milvus.param.collection.HasCollectionParam)">hasCollection</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/HasCollectionParam.html" title="class in io.milvus.param.collection"><code>HasCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: boolean, whether if has collection or not}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="createCollection(io.milvus.param.collection.CreateCollectionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>createCollection</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCollection​(<a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection">CreateCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#createCollection(io.milvus.param.collection.CreateCollectionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Creates a collection in Milvus.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#createCollection(io.milvus.param.collection.CreateCollectionParam)">createCollection</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/CreateCollectionParam.html" title="class in io.milvus.param.collection"><code>CreateCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="dropCollection(io.milvus.param.collection.DropCollectionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>dropCollection</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropCollection​(<a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection">DropCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#dropCollection(io.milvus.param.collection.DropCollectionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Drops a collection. Note that this method drops all data in the collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#dropCollection(io.milvus.param.collection.DropCollectionParam)">dropCollection</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/DropCollectionParam.html" title="class in io.milvus.param.collection"><code>DropCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="loadCollection(io.milvus.param.collection.LoadCollectionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>loadCollection</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadCollection​(<a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection">LoadCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#loadCollection(io.milvus.param.collection.LoadCollectionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Loads a collection to memory before search or query.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#loadCollection(io.milvus.param.collection.LoadCollectionParam)">loadCollection</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/LoadCollectionParam.html" title="class in io.milvus.param.collection"><code>LoadCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>releaseCollection</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> releaseCollection​(<a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection">ReleaseCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Releases a collection from memory to reduce memory usage. Note that you
|
|
|
+ cannot search while the corresponding collection is released from memory.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#releaseCollection(io.milvus.param.collection.ReleaseCollectionParam)">releaseCollection</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/ReleaseCollectionParam.html" title="class in io.milvus.param.collection"><code>ReleaseCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="describeCollection(io.milvus.param.collection.DescribeCollectionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>describeCollection</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeCollectionResponse> describeCollection​(<a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection">DescribeCollectionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows the details of a collection, e.g. name, schema.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#describeCollection(io.milvus.param.collection.DescribeCollectionParam)">describeCollection</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/DescribeCollectionParam.html" title="class in io.milvus.param.collection"><code>DescribeCollectionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:DescribeCollectionResponse{schema,collectionID}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getCollectionStatistics</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCollectionStatisticsResponse> getCollectionStatistics​(<a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection">GetCollectionStatisticsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows the statistics information of a collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getCollectionStatistics(io.milvus.param.collection.GetCollectionStatisticsParam)">getCollectionStatistics</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/GetCollectionStatisticsParam.html" title="class in io.milvus.param.collection"><code>GetCollectionStatisticsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: GetCollectionStatisticsResponse{status,stats}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="showCollections(io.milvus.param.collection.ShowCollectionsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>showCollections</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowCollectionsResponse> showCollections​(<a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection">ShowCollectionsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Lists all collections or gets collection loading status.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#showCollections(io.milvus.param.collection.ShowCollectionsParam)">showCollections</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/ShowCollectionsParam.html" title="class in io.milvus.param.collection"><code>ShowCollectionsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: ShowCollectionsResponse{status,collection_names,collection_ids,created_timestamps,created_utc_timestamps}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="flush(io.milvus.param.collection.FlushParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>flush</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.FlushResponse> flush​(<a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection">FlushParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#flush(io.milvus.param.collection.FlushParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Flushes collections.
|
|
|
+ Currently we do not support this method on client since compaction is not supported on server.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#flush(io.milvus.param.collection.FlushParam)">flush</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/collection/FlushParam.html" title="class in io.milvus.param.collection"><code>FlushParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code,data: FlushResponse{flush segment ids}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="createPartition(io.milvus.param.partition.CreatePartitionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>createPartition</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createPartition​(<a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition">CreatePartitionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#createPartition(io.milvus.param.partition.CreatePartitionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Creates a partition in the specified collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#createPartition(io.milvus.param.partition.CreatePartitionParam)">createPartition</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/CreatePartitionParam.html" title="class in io.milvus.param.partition"><code>CreatePartitionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="dropPartition(io.milvus.param.partition.DropPartitionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>dropPartition</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropPartition​(<a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition">DropPartitionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#dropPartition(io.milvus.param.partition.DropPartitionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Drops a partition. Note that this method drops all data in this partition
|
|
|
+ and the _default partition cannot be dropped.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#dropPartition(io.milvus.param.partition.DropPartitionParam)">dropPartition</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/DropPartitionParam.html" title="class in io.milvus.param.partition"><code>DropPartitionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="hasPartition(io.milvus.param.partition.HasPartitionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>hasPartition</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><java.lang.Boolean> hasPartition​(<a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition">HasPartitionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#hasPartition(io.milvus.param.partition.HasPartitionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Checks if a partition exists in the specified collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#hasPartition(io.milvus.param.partition.HasPartitionParam)">hasPartition</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/HasPartitionParam.html" title="class in io.milvus.param.partition"><code>HasPartitionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: boolean, whether if has collection or not}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>loadPartitions</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadPartitions​(<a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition">LoadPartitionsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Loads a partition into memory.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#loadPartitions(io.milvus.param.partition.LoadPartitionsParam)">loadPartitions</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/LoadPartitionsParam.html" title="class in io.milvus.param.partition"><code>LoadPartitionsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>releasePartitions</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> releasePartitions​(<a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition">ReleasePartitionsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Releases a partition from memory.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#releasePartitions(io.milvus.param.partition.ReleasePartitionsParam)">releasePartitions</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/ReleasePartitionsParam.html" title="class in io.milvus.param.partition"><code>ReleasePartitionsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getPartitionStatistics</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPartitionStatisticsResponse> getPartitionStatistics​(<a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition">GetPartitionStatisticsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows the statistics information of a partition.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getPartitionStatistics(io.milvus.param.partition.GetPartitionStatisticsParam)">getPartitionStatistics</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/GetPartitionStatisticsParam.html" title="class in io.milvus.param.partition"><code>GetPartitionStatisticsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code,data:GetPartitionStatisticsResponse{status,stats}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="showPartitions(io.milvus.param.partition.ShowPartitionsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>showPartitions</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ShowPartitionsResponse> showPartitions​(<a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition">ShowPartitionsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows all partitions in the specified collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#showPartitions(io.milvus.param.partition.ShowPartitionsParam)">showPartitions</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/partition/ShowPartitionsParam.html" title="class in io.milvus.param.partition"><code>ShowPartitionsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:ShowPartitionsResponse{partition_names,partitionIDs,created_timestamps,created_utc_timestamps}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="createAlias(io.milvus.param.alias.CreateAliasParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>createAlias</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createAlias​(<a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias">CreateAliasParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#createAlias(io.milvus.param.alias.CreateAliasParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Creates an alias for a collection.
|
|
|
+ Alias can be used in search or query to replace the collection name</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#createAlias(io.milvus.param.alias.CreateAliasParam)">createAlias</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/alias/CreateAliasParam.html" title="class in io.milvus.param.alias"><code>CreateAliasParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="dropAlias(io.milvus.param.alias.DropAliasParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>dropAlias</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropAlias​(<a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias">DropAliasParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#dropAlias(io.milvus.param.alias.DropAliasParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Drops an alias for the specified collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#dropAlias(io.milvus.param.alias.DropAliasParam)">dropAlias</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/alias/DropAliasParam.html" title="class in io.milvus.param.alias"><code>DropAliasParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="alterAlias(io.milvus.param.alias.AlterAliasParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>alterAlias</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> alterAlias​(<a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias">AlterAliasParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#alterAlias(io.milvus.param.alias.AlterAliasParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Alters alias from a collection to another.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#alterAlias(io.milvus.param.alias.AlterAliasParam)">alterAlias</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/alias/AlterAliasParam.html" title="class in io.milvus.param.alias"><code>AlterAliasParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="createIndex(io.milvus.param.index.CreateIndexParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>createIndex</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createIndex​(<a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index">CreateIndexParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#createIndex(io.milvus.param.index.CreateIndexParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Creates an index on a vector field in the specified collection.
|
|
|
+ Note that index building is an async progress.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#createIndex(io.milvus.param.index.CreateIndexParam)">createIndex</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/index/CreateIndexParam.html" title="class in io.milvus.param.index"><code>CreateIndexParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="dropIndex(io.milvus.param.index.DropIndexParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>dropIndex</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> dropIndex​(<a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index">DropIndexParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#dropIndex(io.milvus.param.index.DropIndexParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Drops the index on a vector field in the specified collection.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#dropIndex(io.milvus.param.index.DropIndexParam)">dropIndex</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/index/DropIndexParam.html" title="class in io.milvus.param.index"><code>DropIndexParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="describeIndex(io.milvus.param.index.DescribeIndexParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>describeIndex</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.DescribeIndexResponse> describeIndex​(<a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index">DescribeIndexParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#describeIndex(io.milvus.param.index.DescribeIndexParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows the information of the specified index. Current release of Milvus
|
|
|
+ only supports showing latest built index.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#describeIndex(io.milvus.param.index.DescribeIndexParam)">describeIndex</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/index/DescribeIndexParam.html" title="class in io.milvus.param.index"><code>DescribeIndexParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:DescribeIndexResponse{status,index_descriptions}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getIndexState(io.milvus.param.index.GetIndexStateParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getIndexState</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexStateResponse> getIndexState​(<a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index">GetIndexStateParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows the index building state(in-progress/finished/failed), and the reason for failure (if any).</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getIndexState(io.milvus.param.index.GetIndexStateParam)">getIndexState</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/index/GetIndexStateParam.html" title="class in io.milvus.param.index"><code>GetIndexStateParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetIndexStateResponse{status,state}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getIndexBuildProgress</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetIndexBuildProgressResponse> getIndexBuildProgress​(<a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index">GetIndexBuildProgressParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Shows the index building progress, such as how many rows are indexed.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getIndexBuildProgress(io.milvus.param.index.GetIndexBuildProgressParam)">getIndexBuildProgress</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/index/GetIndexBuildProgressParam.html" title="class in io.milvus.param.index"><code>GetIndexBuildProgressParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetIndexBuildProgressResponse{status,indexed_rows}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="insert(io.milvus.param.dml.InsertParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>insert</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> insert​(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#insert(io.milvus.param.dml.InsertParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Inserts entities into a specified collection . Note that you don't need to
|
|
|
+ input primary key field if auto_id is enabled.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#insert(io.milvus.param.dml.InsertParam)">insert</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: MutationResult{insert results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="insertAsync(io.milvus.param.dml.InsertParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>insertAsync</h4>
|
|
|
+<pre class="methodSignature">public com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult>> insertAsync​(<a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml">InsertParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#insertAsync(io.milvus.param.dml.InsertParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Inserts entities into a specified collection asynchronously. Note that you don't need to
|
|
|
+ input primary key field if auto_id is enabled.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#insertAsync(io.milvus.param.dml.InsertParam)">insertAsync</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/InsertParam.html" title="class in io.milvus.param.dml"><code>InsertParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: MutationResult{insert results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="delete(io.milvus.param.dml.DeleteParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>delete</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.MutationResult> delete​(<a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml">DeleteParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#delete(io.milvus.param.dml.DeleteParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Deletes entity(s) based on primary key(s) filtered by boolean expression. Current release
|
|
|
+ of Milvus only supports expression in the format "pk_field in [1, 2, ...]"</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#delete(io.milvus.param.dml.DeleteParam)">delete</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/DeleteParam.html" title="class in io.milvus.param.dml"><code>DeleteParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: MutationResult{delete results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="search(io.milvus.param.dml.SearchParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>search</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults> search​(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#search(io.milvus.param.dml.SearchParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Conducts ANN search on a vector field. Use expression to do filtering before search.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#search(io.milvus.param.dml.SearchParam)">search</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: SearchResults{topK results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="searchAsync(io.milvus.param.dml.SearchParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>searchAsync</h4>
|
|
|
+<pre class="methodSignature">public com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.SearchResults>> searchAsync​(<a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#searchAsync(io.milvus.param.dml.SearchParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Conducts ANN search on a vector field asynchronously. Use expression to do filtering before search.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#searchAsync(io.milvus.param.dml.SearchParam)">searchAsync</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/SearchParam.html" title="class in io.milvus.param.dml"><code>SearchParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>a <code>ListenableFuture</code> object which holds the object {status:result code, data: SearchResults{topK results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="query(io.milvus.param.dml.QueryParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>query</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults> query​(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#query(io.milvus.param.dml.QueryParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Queries entity(s) based on scalar field(s) filtered by boolean expression.
|
|
|
+ Note that the order of the returned entities cannot be guaranteed.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#query(io.milvus.param.dml.QueryParam)">query</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code,data: QueryResults{filter results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="queryAsync(io.milvus.param.dml.QueryParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>queryAsync</h4>
|
|
|
+<pre class="methodSignature">public com.google.common.util.concurrent.ListenableFuture<<a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.QueryResults>> queryAsync​(<a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#queryAsync(io.milvus.param.dml.QueryParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Queries entity(s) asynchronously based on scalar field(s) filtered by boolean expression.
|
|
|
+ Note that the order of the returned entities cannot be guaranteed.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#queryAsync(io.milvus.param.dml.QueryParam)">queryAsync</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/QueryParam.html" title="class in io.milvus.param.dml"><code>QueryParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code,data: QueryResults{filter results}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="calcDistance(io.milvus.param.dml.CalcDistanceParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>calcDistance</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.CalcDistanceResults> calcDistance​(<a href="../param/dml/CalcDistanceParam.html" title="class in io.milvus.param.dml">CalcDistanceParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#calcDistance(io.milvus.param.dml.CalcDistanceParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Calculates the distance between the specified vectors.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#calcDistance(io.milvus.param.dml.CalcDistanceParam)">calcDistance</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/dml/CalcDistanceParam.html" title="class in io.milvus.param.dml"><code>CalcDistanceParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data: CalcDistanceResults{distances}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getMetrics(io.milvus.param.control.GetMetricsParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getMetrics</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetMetricsResponse> getMetrics​(<a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control">GetMetricsParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Gets the runtime metrics information of Milvus, returns the result in .json format.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getMetrics(io.milvus.param.control.GetMetricsParam)">getMetrics</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetMetricsParam.html" title="class in io.milvus.param.control"><code>GetMetricsParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getFlushState(io.milvus.param.control.GetFlushStateParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getFlushState</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetFlushStateResponse> getFlushState​(<a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control">GetFlushStateParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Get flush state of specified segments.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getFlushState(io.milvus.param.control.GetFlushStateParam)">getFlushState</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetFlushStateParam.html" title="class in io.milvus.param.control"><code>GetFlushStateParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetMetricsResponse{status,metrics}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getPersistentSegmentInfo</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetPersistentSegmentInfoResponse> getPersistentSegmentInfo​(<a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control">GetPersistentSegmentInfoParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Gets the information of persistent segments from data node, including row count,
|
|
|
+ persistence state(growing or flushed), etc.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getPersistentSegmentInfo(io.milvus.param.control.GetPersistentSegmentInfoParam)">getPersistentSegmentInfo</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetPersistentSegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetPersistentSegmentInfoParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetPersistentSegmentInfoResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getQuerySegmentInfo</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetQuerySegmentInfoResponse> getQuerySegmentInfo​(<a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control">GetQuerySegmentInfoParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Gets the query information of segments in a collection from query node, including row count,
|
|
|
+ memory usage size, index name, etc.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getQuerySegmentInfo(io.milvus.param.control.GetQuerySegmentInfoParam)">getQuerySegmentInfo</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetQuerySegmentInfoParam.html" title="class in io.milvus.param.control"><code>GetQuerySegmentInfoParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetQuerySegmentInfoResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getReplicas(io.milvus.param.control.GetReplicasParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getReplicas</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetReplicasResponse> getReplicas​(<a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control">GetReplicasParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getReplicas(io.milvus.param.control.GetReplicasParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Returns the collection's replica information</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getReplicas(io.milvus.param.control.GetReplicasParam)">getReplicas</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetReplicasParam.html" title="class in io.milvus.param.control"><code>GetReplicasParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetReplicasResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="loadBalance(io.milvus.param.control.LoadBalanceParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>loadBalance</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> loadBalance​(<a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control">LoadBalanceParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Moves segment from a query node to another to keep the load balanced.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#loadBalance(io.milvus.param.control.LoadBalanceParam)">loadBalance</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/LoadBalanceParam.html" title="class in io.milvus.param.control"><code>LoadBalanceParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getCompactionState(io.milvus.param.control.GetCompactionStateParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getCompactionState</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionStateResponse> getCompactionState​(<a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control">GetCompactionStateParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Gets the compaction state by id.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getCompactionState(io.milvus.param.control.GetCompactionStateParam)">getCompactionState</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetCompactionStateParam.html" title="class in io.milvus.param.control"><code>GetCompactionStateParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetCompactionStateResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="manualCompaction(io.milvus.param.control.ManualCompactionParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>manualCompaction</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ManualCompactionResponse> manualCompaction​(<a href="../param/control/ManualCompactionParam.html" title="class in io.milvus.param.control">ManualCompactionParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#manualCompaction(io.milvus.param.control.ManualCompactionParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Performs a manual compaction.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#manualCompaction(io.milvus.param.control.ManualCompactionParam)">manualCompaction</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/ManualCompactionParam.html" title="class in io.milvus.param.control"><code>ManualCompactionParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:ManualCompactionResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>getCompactionStateWithPlans</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.GetCompactionPlansResponse> getCompactionStateWithPlans​(<a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control">GetCompactionPlansParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Gets compaction state with its plan.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#getCompactionStateWithPlans(io.milvus.param.control.GetCompactionPlansParam)">getCompactionStateWithPlans</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/control/GetCompactionPlansParam.html" title="class in io.milvus.param.control"><code>GetCompactionPlansParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:GetCompactionPlansResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="createCredential(io.milvus.param.credential.CreateCredentialParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>createCredential</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> createCredential​(<a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential">CreateCredentialParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#createCredential(io.milvus.param.credential.CreateCredentialParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Create credential using the given user and password.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#createCredential(io.milvus.param.credential.CreateCredentialParam)">createCredential</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/credential/CreateCredentialParam.html" title="class in io.milvus.param.credential"><code>CreateCredentialParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="updateCredential(io.milvus.param.credential.UpdateCredentialParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>updateCredential</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> updateCredential​(<a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential">UpdateCredentialParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Update credential using the given user and password.
|
|
|
+ You must provide the original password to check if the operation is valid.
|
|
|
+ Note: after this operation, client won't change the related header of this connection.
|
|
|
+ So if you update credential for this connection, the connection may be invalid.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#updateCredential(io.milvus.param.credential.UpdateCredentialParam)">updateCredential</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/credential/UpdateCredentialParam.html" title="class in io.milvus.param.credential"><code>UpdateCredentialParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockList">
|
|
|
+<li class="blockList">
|
|
|
+<h4>deleteCredential</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><<a href="../param/RpcStatus.html" title="class in io.milvus.param">RpcStatus</a>> deleteCredential​(<a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential">DeleteCredentialParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">Delete credential corresponding to the user.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#deleteCredential(io.milvus.param.credential.DeleteCredentialParam)">deleteCredential</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/credential/DeleteCredentialParam.html" title="class in io.milvus.param.credential"><code>DeleteCredentialParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:RpcStatus{msg: result message}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+<a id="listCredUsers(io.milvus.param.credential.ListCredUsersParam)">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="blockListLast">
|
|
|
+<li class="blockList">
|
|
|
+<h4>listCredUsers</h4>
|
|
|
+<pre class="methodSignature">public <a href="../param/R.html" title="class in io.milvus.param">R</a><io.milvus.grpc.ListCredUsersResponse> listCredUsers​(<a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential">ListCredUsersParam</a> requestParam)</pre>
|
|
|
+<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="MilvusClient.html#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">MilvusClient</a></code></span></div>
|
|
|
+<div class="block">List all user names.</div>
|
|
|
+<dl>
|
|
|
+<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
|
+<dd><code><a href="MilvusClient.html#listCredUsers(io.milvus.param.credential.ListCredUsersParam)">listCredUsers</a></code> in interface <code><a href="MilvusClient.html" title="interface in io.milvus.client">MilvusClient</a></code></dd>
|
|
|
+<dt><span class="paramLabel">Parameters:</span></dt>
|
|
|
+<dd><code>requestParam</code> - <a href="../param/credential/ListCredUsersParam.html" title="class in io.milvus.param.credential"><code>ListCredUsersParam</code></a></dd>
|
|
|
+<dt><span class="returnLabel">Returns:</span></dt>
|
|
|
+<dd>{status:result code, data:ListCredUsersResponse{status,info}}</dd>
|
|
|
+</dl>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</section>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+</div>
|
|
|
+</main>
|
|
|
+<!-- ========= END OF CLASS DATA ========= -->
|
|
|
+<footer role="contentinfo">
|
|
|
+<nav role="navigation">
|
|
|
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
+<div class="bottomNav"><a id="navbar.bottom">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
|
+<a id="navbar.bottom.firstrow">
|
|
|
+<!-- -->
|
|
|
+</a>
|
|
|
+<ul class="navList" title="Navigation">
|
|
|
+<li><a href="../../../index.html">Overview</a></li>
|
|
|
+<li><a href="package-summary.html">Package</a></li>
|
|
|
+<li class="navBarCell1Rev">Class</li>
|
|
|
+<li><a href="package-tree.html">Tree</a></li>
|
|
|
+<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
|
+<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
|
+<li><a href="../../../help-doc.html">Help</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<div class="subNav">
|
|
|
+<ul class="navList" id="allclasses_navbar_bottom">
|
|
|
+<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
|
+</ul>
|
|
|
+<div>
|
|
|
+<script type="text/javascript"><!--
|
|
|
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
|
+ if(window==top) {
|
|
|
+ allClassesLink.style.display = "block";
|
|
|
+ }
|
|
|
+ else {
|
|
|
+ allClassesLink.style.display = "none";
|
|
|
+ }
|
|
|
+ //-->
|
|
|
+</script>
|
|
|
+<noscript>
|
|
|
+<div>JavaScript is disabled on your browser.</div>
|
|
|
+</noscript>
|
|
|
+</div>
|
|
|
+<div>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Summary: </li>
|
|
|
+<li>Nested | </li>
|
|
|
+<li>Field | </li>
|
|
|
+<li><a href="#constructor.summary">Constr</a> | </li>
|
|
|
+<li><a href="#method.summary">Method</a></li>
|
|
|
+</ul>
|
|
|
+<ul class="subNavList">
|
|
|
+<li>Detail: </li>
|
|
|
+<li>Field | </li>
|
|
|
+<li><a href="#constructor.detail">Constr</a> | </li>
|
|
|
+<li><a href="#method.detail">Method</a></li>
|
|
|
+</ul>
|
|
|
+</div>
|
|
|
+<a id="skip.navbar.bottom">
|
|
|
+<!-- -->
|
|
|
+</a></div>
|
|
|
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
+</nav>
|
|
|
+</footer>
|
|
|
+</body>
|
|
|
+</html>
|