You need to enable JavaScript to run this app.
导航

del_data

最近更新时间2023.11.09 18:59:53

首次发布时间2023.11.03 15:00:09

概述

/collection/del_data 接口用于在指定的 Collection 删除数据,支持以下几种方法:

  1. 在指定的 Collection 中,根据主键删除单条或多条数据,单次最多允许删除100条数据。
  2. 删除指定的 Collection 下所有数据。

请求接口

说明

请求向量数据库 VikingDB 的 OpenAPI 接口时,需要构造签名进行鉴权,详细的 OpenAPI 签名调用方法请参见 API签名调用指南

URI

/api/collection/del_data

统一资源标识符

请求方法

POST

客户端对向量数据库服务器请求的操作类型

请求头

Content-Type: application/json

请求消息类型

Authorization: HMAC-SHA256 ***

鉴权

请求参数

参数

类型

是否必选

参数说明

collection_name

string

指定删除数据的 Collection 名称。

  • 只能使用英文字母、数字、下划线_,并以英文字母开头,不能为空。
  • 长度要求:[1, 128]。
  • Collection 名称不能重复。

primary_keys

int64、
array<int64>、
string、
array<string>

二选一

指定主键字段值,单次最多删除100条数据。primary_keys设置为不同类型时,数据删除逻辑如下:

  • int64类型string类型:单条数据删除。
  • array<int64>array<string>:多条数据删除,数据条数为外层 array 长度,最大100条。

del_all

bool

当值为true时,表示删除所有数据;默认为false。

  • 删除所有数据后需要时间更新到 Index,即一段时间内 Index 中仍可检索到数据。

响应消息

参数

参数说明

code

状态码

message

返回信息

request_id

标识每个请求的唯一标识符

状态码说明

状态码

http状态码

返回信息

状态码说明

0

200

success

指定的 Collection 删除数据成功。

1000005

400

collection not exist

Collection 不存在。

1000003

400

invalid request:%s

非法参数:

  • 缺失必选参数。
  • 主键字段值缺失。

1000001

401

unauthorized

请求头中缺乏鉴权信息。

1000002

403

no permission

权限不足。

完整示例

请求消息

curl -i -X POST \
  -H 'Content-Type: application/json' \
  -H 'Authorization: HMAC-SHA256 ***' \
  http://***/api/collection/del_data \
  -d '{
    "collection_name": "test_name",
    "primary_keys": [                               
        123,     
        124    
    ]
}'

响应消息

执行成功返回:

HTTP/1.1 200 OK
Content-Length: 43
Content-Type: application/json
 
{
    "code":0,
    "msg":"success",
    "request_id":"021695029736548fd001de66666000000000000000000029aa917"
}

执行失败返回:

HTTP/1.1 400 OK
Content-Length: 43
Content-Type: application/json
 
{"code":1,"msg":"collection not exist","request_id":"021695029736548fd001de66666000000000000000000029aa917"}