You need to enable JavaScript to run this app.
导航
DeleteData
最近更新时间:2024.06.14 11:34:52首次发布时间:2024.06.14 11:34:52

概述

DeleteData 用于在指定的 Collection 删除数据,根据主键删除单条或多条数据,单次最多允许删除100条数据。

请求参数
type DeleteDataRequest = 
  | DeleteSpecifyDataRequest
  | DeleteAllDataRequest

DeleteSpecifyDataRequest 删除指定数据

字段名

类型

是否必传

说明

CollectionName/CollectionAlias

string

数据集名称或数据集别名,二选一

PrimaryKeys

Array<string | number>

主键值,类型对齐定义的主键字段

DeleteAllDataRequest 删除全部数据

字段名

类型

是否必传

说明

CollectionName/CollectionAlias

string

数据集名称或数据集别名,二选一

DeleteAll

true

删除全部

响应参数
declare class VikingdbResponse {
  readonly OriginalRequest: string;
  readonly LogId: string;
  constructor(
    OriginalRequest: string,
    LogId: string
  );
}

参考示例
import { vikingdb } from '@volcengine/openapi'

declare const service: vikingdb.VikingdbService // 替换为你初始化好的实例

await service.data.DeleteData({
  CollectionName: 'test_collection_1',
  PrimaryKeys: [1, 2]
})

await service.data.DeleteData({
  CollectionAlias: 'test_collection_alias_1',
  DeleteAll: true
})