二级索引

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

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

唯一索引（一对一）跳至标题

唯一索引的每个索引中的键都与 exactly one 主键相关联。例如，在存储用户数据并通过其唯一 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 检索用户以获取用户的电子邮件地址。这是为了检索构造指向该用户地址的二级索引的键所需的电子邮件。然后，它执行一个原子操作，该操作检查数据库中的用户是否未更改，然后删除指向用户值的两个主键和二级索引。如果失败（用户在查询和删除之间被修改），原子操作将中止。整个过程将被重试，直到删除成功。该检查是必需的，以防止查询和删除之间可能修改值的竞争条件。如果更新更改了用户的电子邮件，则可能会发生这种竞争，因为在这种情况下二级索引会移动。然后，二级索引的删除将失败，因为删除正在针对旧的二级索引键。

非唯一索引（一对多）跳至标题

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

要为此示例实现非唯一二级索引，请执行以下步骤

定义 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。

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

二级索引

唯一索引（一对一） 跳至标题#

非唯一索引（一对多） 跳至标题#

唯一索引（一对一）跳至标题

非唯一索引（一对多）跳至标题