delete - 删除数据
delete() 用于从 collection 中删除记录。您可以按ID、元数据筛选器或文档筛选器删除。
信息
仅支持在使用 SeekdbClient 连接时,才能使用该接口。关于 SeekdbClient 的详细介绍,参见 SeekdbClient。
前提条件
-
您已经安装了 seekdb-js,有关安装 seekdb-js 的详细信息,参见 快速开始。
-
您已经安装了 seekdb 服务器模式,有关安装 seekdb 服务器模式的详细信息,参见 通过 yum install 部署 seekdb。
-
您已经连接到数据库。有关连接的详细操作参见 SeekdbClient。
-
请确保连接的用户已拥有待操作的表的
DELETE权限,查看当前用户权限的相关操作请参见 查看用户权限。如果不具备该权限,请联系管理员为您授权,用户授权的相关操作请参见 直接授予权限。
请求参数
delete(
ids: ids,
where=Metadata,
whereDocument=documents,
)
| 参数 | 取值类型 | 是否必选 | 描述 | 取值示例 |
|---|---|---|---|---|
ids | string | string[] | 可选 | 需要删除的 ID。可以是单个,也可以是数组。 | item1 |
where | Where | 可选 | Metadata 筛选条件。 | {category: {$eq: "AI" }} |
whereDocument | WhereDocument | 可选 | Document 筛选条件。 | { $contains: "obsolete" } |
信息
ids、where 或 whereDocument 中必须至少有一个。
请求示例
import { SeekdbClient } from "seekdb";
const client = new SeekdbClient({
host: "127.0.0.1",
port: 2881,
user: "root",
password: "",
database: "test",
});
const collection = await client.getCollection({
name: "my_collection"
});
await collection.delete({
ids: "item1"
});
await collection.delete({ where: { category: { $eq: "AI" } } });
await collection.delete({ whereDocument: { $contains: "obsolete" } });
返回参数
无