二级索引

类似 Deno KV 的键值存储将数据组织为键值对的集合，其中每个唯一键都与一个值关联。这种结构可以轻松地根据键检索值，但不允许基于值本身进行查询。为了克服这个限制，您可以创建二级索引，它在包含（部分）该值的附加键下存储相同的值。

在使用二级索引时，维护主键和二级键之间的一致性至关重要。如果在更新主键的值时没有更新二级键，则从针对二级键的查询返回的数据将不正确。为了确保主键和二级键始终表示相同的数据，在插入、更新或删除数据时使用原子操作。这种方法确保突变操作组作为一个单元执行，要么全部成功，要么全部失败，从而防止不一致。

唯一索引（一对一） Jump to heading

唯一索引中的每个键都与一个主键关联。例如，当存储用户数据并按其唯一 ID 和电子邮件地址查找用户时，请将用户数据存储在两个单独的键下：一个用于主键（用户 ID），另一个用于二级索引（电子邮件）。这种设置允许根据用户的 ID 或电子邮件查询用户。二级索引还可以对存储中的值强制执行唯一性约束。在用户数据的情况下，使用索引来确保每个电子邮件地址仅与一个用户关联 - 换句话说，电子邮件是唯一的。

要为此示例实现唯一二级索引，请按照以下步骤操作

创建一个表示数据的 User 接口

interface User {
  id: string;
  name: string;
  email: string;
}

定义一个 insertUser 函数，该函数将用户数据存储在主键和二级键中

async function insertUser(user: User) {
  const primaryKey = ["users", user.id];
  const byEmailKey = ["users_by_email", user.email];
  const res = await kv.atomic()
    .check({ key: primaryKey, versionstamp: null })
    .check({ key: byEmailKey, versionstamp: null })
    .set(primaryKey, user)
    .set(byEmailKey, user)
    .commit();
  if (!res.ok) {
    throw new TypeError("User with ID or email already exists");
  }
}

此函数使用原子操作执行插入，以检查是否已存在具有相同 ID 或电子邮件的用户。如果违反了这些约束中的任何一个，则插入失败并且不修改任何数据。

定义一个 getUser 函数，以按 ID 检索用户

async function getUser(id: string): Promise<User | null> {
  const res = await kv.get<User>(["users", id]);
  return res.value;
}

定义一个 getUserByEmail 函数，以按电子邮件地址检索用户

async function getUserByEmail(email: string): Promise<User | null> {
  const res = await kv.get<User>(["users_by_email", email]);
  return res.value;
}

此函数使用二级键 (["users_by_email", email]) 查询存储。

定义一个 deleteUser 函数，以按 ID 删除用户
```
async function deleteUser(id: string) {
  let res = { ok: false };
  while (!res.ok) {
    const getRes = await kv.get<User>(["users", id]);
    if (getRes.value === null) return;
    res = await kv.atomic()
      .check(getRes)
      .delete(["users", id])
      .delete(["users_by_email", getRes.value.email])
      .commit();
  }
}
```
此函数首先按 ID 检索用户以获取用户的电子邮件地址。这是检索构建此用户地址的二级索引的键所需的电子邮件所必需的。然后，它执行原子操作，检查数据库中的用户是否已更改，然后删除指向用户值的主键和二级键。如果失败（用户在查询和删除之间已被修改），则原子操作中止。重试整个过程，直到删除成功。需要此检查以防止在检索和删除之间值可能已被修改的竞争条件。如果更新更改了用户的电子邮件，则可能会发生此竞争，因为在这种情况下二级索引会移动。然后二级索引的删除将失败，因为删除的目标是旧的二级索引键。

非唯一索引（一对多） Jump to heading

非唯一索引是二级索引，其中单个键可以与多个主键关联，从而允许您根据共享属性查询多个项目。例如，当按用户最喜欢的颜色查询用户时，请使用非唯一二级索引来实现此目的。最喜欢的颜色是非唯一属性，因为多个用户可以具有相同的最喜欢的颜色。

要为此示例实现非唯一二级索引，请按照以下步骤操作

定义 User 接口

interface User {
  id: string;
  name: string;
  favoriteColor: string;
}

定义 insertUser 函数

async function insertUser(user: User) {
  const primaryKey = ["users", user.id];
  const byColorKey = [
    "users_by_favorite_color",
    user.favoriteColor,
    user.id,
  ];
  await kv.atomic()
    .check({ key: primaryKey, versionstamp: null })
    .set(primaryKey, user)
    .set(byColorKey, user)
    .commit();
}

定义一个函数，以按用户最喜欢的颜色检索用户

async function getUsersByFavoriteColor(color: string): Promise<User[]> {
  const iter = kv.list<User>({ prefix: ["users_by_favorite_color", color] });
  const users = [];
  for await (const { value } of iter) {
    users.push(value);
  }
  return users;
}

此示例演示了非唯一二级索引 users_by_favorite_color 的用法，该索引允许根据用户最喜欢的颜色查询用户。主键仍然是用户 id。

唯一索引和非唯一索引的实现之间的主要区别在于二级键的结构和组织。在唯一索引中，每个二级键都与一个主键关联，从而确保索引属性在所有记录中都是唯一的。在非唯一索引的情况下，单个二级键可以与多个主键关联，因为索引属性可以在多个记录之间共享。为了实现这一点，非唯一二级键通常以附加的唯一标识符（例如，主键）作为键的一部分进行结构化，从而允许多个具有相同属性的记录共存而不会发生冲突。

二级索引

唯一索引（一对一） Jump to heading#

非唯一索引（一对多） Jump to heading#

您找到所需的内容了吗？

唯一索引（一对一） Jump to heading

非唯一索引（一对多） Jump to heading