刪除Doc
本文介紹如何通過Java SDK，根據(jù)id或id列表刪除Collection中已存在的Doc。
如果指定id不存在，則刪除對(duì)應(yīng)Doc的操作無效。
前提條件
已創(chuàng)建Cluster：創(chuàng)建Cluster。
已獲得API-KEY：API-KEY管理。
已安裝最新版SDK：安裝DashVector SDK。
接口定義
// class DashVectorCollection
// 同步接口
public Response<List<DocOpResult>> delete(DeleteDocRequest deleteDocRequest);
// 異步接口
public ListenableFuture<Response<List<DocOpResult>>> deleteAsync(DeleteDocRequest deleteDocRequest);使用示例
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運(yùn)行。
本示例需要參考新建Collection-使用示例提前創(chuàng)建好名稱為
quickstart的Collection，并參考插入Doc提前插入部分?jǐn)?shù)據(jù)。
import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.common.DashVectorException;
import com.aliyun.dashvector.models.requests.DeleteDocRequest;
import com.aliyun.dashvector.models.responses.Response;
public class Main {
public static void main(String[] args) throws DashVectorException {
DashVectorClient client = new DashVectorClient("YOUR_API_KEY", "YOUR_CLUSTER_ENDPOINT");
DashVectorCollection collection = client.get("quickstart");
// 構(gòu)建 DeleteDocRequest
DeleteDocRequest request = DeleteDocRequest.builder()
.id("1")
.build();
// 發(fā)送刪除Doc請(qǐng)求
Response<List<DocOpResult>> response = collection.delete(request);
}
}
入?yún)⒚枋?/h2>
通過DeleteDocRequestBuilder構(gòu)造DeleteDocRequest對(duì)象，其可用方法如下表所示：
方法 | 必填 | 默認(rèn)值 | 描述 |
ids(List<String> ids) | 是 | - | 文檔主鍵列表 |
id(String id) | 否 | - | |
partition(String partition) | 否 | default | 分區(qū)名稱 |
deleteAll(Boolean deleteAll) | 否 | false | 是否清除分區(qū)內(nèi)的全部數(shù)據(jù)。當(dāng)傳入 |
build() | - | - | 構(gòu)造 |
出參描述
返回結(jié)果為Response<List<DocOpResult>>對(duì)象，Response<List<DocOpResult>>對(duì)象中可獲取本次操作結(jié)果信息，如下表所示。
方法 | 類型 | 描述 | 示例 |
getCode() | int | 返回值，參考返回狀態(tài)碼說明 | 0 |
getMessage() | String | 返回消息 | success |
getRequestId() | String | 請(qǐng)求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
getOutput() | List<DocOpResult> | 返回刪除的結(jié)果 | |
getUsage() | 對(duì)Serverless實(shí)例（按量付費(fèi)）集合的Doc刪除請(qǐng)求，成功后返回實(shí)際消耗的寫請(qǐng)求單元數(shù) | ||
isSuccess() | Boolean | 判斷請(qǐng)求是否成功 | true |