deno.com
本页内容

二级索引

Deno KV 等键值存储将数据组织为键值对的集合,其中每个唯一的键都与单个值相关联。这种结构便于根据键检索值,但不允许根据值本身进行查询。为了克服此限制,您可以创建二级索引,这些索引将相同的值存储在包含该值(部分)的附加键下。

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

唯一索引(一对一) Jump to heading

唯一索引中的每个键都与一个主键精确关联。例如,在存储用户数据并根据其唯一 ID 和电子邮件地址查找用户时,将用户数据存储在两个单独的键下:一个用于主键(用户 ID),另一个用于二级索引(电子邮件)。此设置允许根据用户的 ID 或电子邮件查询用户。二级索引还可以强制执行存储中值的唯一性约束。对于用户数据,使用该索引可确保每个电子邮件地址仅与一个用户关联——换句话说,电子邮件是唯一的。

要实现此示例的唯一二级索引,请遵循以下步骤

  1. 创建表示数据的 User 接口

    interface User {
      id: string;
      name: string;
      email: string;
    }
    
  2. 定义一个 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 或电子邮件的用户。如果违反了其中任何一个约束,则插入失败,并且不修改任何数据。

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

    async function getUser(id: string): Promise<User | null> {
      const res = await kv.get<User>(["users", id]);
      return res.value;
    }
    
  4. 定义一个 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]) 查询存储。

  5. 定义一个 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

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

要实现此示例的非唯一二级索引,请遵循以下步骤

  1. 定义 User 接口

    interface User {
      id: string;
      name: string;
      favoriteColor: string;
    }
    
  2. 定义 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();
    }
    
  3. 定义一个函数以按用户最喜欢的颜色检索用户

    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

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

您找到所需内容了吗?

隐私政策