本文介紹如何通過Java SDK，根據id或id列表刪除Collection中已存在的Doc。
如果指定id不存在，則刪除對應Doc的操作無效。
前提條件
已創建Cluster：創建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，代碼才能正常運行。
本示例需要參考新建Collection-使用示例提前創建好名稱為
quickstart的Collection，并參考插入Doc提前插入部分數據。
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");
// 構建 DeleteDocRequest
DeleteDocRequest request = DeleteDocRequest.builder()
.id("1")
.build();
// 發送刪除Doc請求
Response<List<DocOpResult>> response = collection.delete(request);
}
}
入參描述
通過DeleteDocRequestBuilder構造DeleteDocRequest對象，其可用方法如下表所示：
方法 | 必填 | 默認值 | 描述 |
ids(List<String> ids) | 是 | - | 文檔主鍵列表 |
id(String id) | 否 | - | |
partition(String partition) | 否 | default | 分區名稱 |
deleteAll(Boolean deleteAll) | 否 | false | 是否清除分區內的全部數據。當傳入 |
build() | - | - | 構造 |
出參描述
返回結果為Response<List<DocOpResult>>對象，Response<List<DocOpResult>>對象中可獲取本次操作結果信息，如下表所示。
方法 | 類型 | 描述 | 示例 |
getCode() | int | 返回值，參考返回狀態碼說明 | 0 |
getMessage() | String | 返回消息 | success |
getRequestId() | String | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
getOutput() | List<DocOpResult> | 返回刪除的結果 | |
getUsage() | 對Serverless實例（按量付費）集合的Doc刪除請求，成功后返回實際消耗的寫請求單元數 | ||
isSuccess() | Boolean | 判斷請求是否成功 | true |