Spec-Zone.ru › Deno 2

Метод Deno.Kv.prototype.list

Kv.prototype.list<T = unknown>(selector: KvListSelector,options?: KvListOptions,): KvListIterator<T>

Получение списка ключей в базе данных. Возвращаемый список — это Deno.KvListIterator, который можно использовать для итерации по записям в базе данных.

Каждая операция списка должна указать селектор, который используется для указания диапазона ключей для возврата. Селектор может быть либо селектором префикса, либо селектором диапазона:

  • Селектор префикса выбирает все ключи, начинающиеся с заданного префикса частей ключа. Например, селектор ["users"] выберет все ключи, начинающиеся с префикса ["users"], такие как ["users", "alice"] и ["users", "bob"]. Обратите внимание, что вы не можете частично сопоставлять часть ключа, поэтому селектор ["users", "a"] не будет соответствовать ключу ["users", "alice"]. Селектор префикса может указать start ключ, который используется для пропуска ключей, лексикографически меньших, чем начальный ключ.
  • Селектор диапазона выбирает все ключи, которые лексикографически находятся между заданными начальным и конечным ключами (включая начальный и исключая конечный). Например, селектор ["users", "a"], ["users", "n"] выберет все ключи, начинающиеся с префикса ["users"] и имеющие вторую часть ключа, которая лексикографически находится между a и n, такие как ["users", "alice"], ["users", "bob"], и ["users", "mike"], но не ["users", "noa"] или ["users", "zoe"].
const db = await Deno.openKv();
const entries = db.list({ prefix: ["users"] });
for await (const entry of entries) {
  entry.key; // ["users", "alice"]
  entry.value; // { name: "Alice" }
  entry.versionstamp; // "00000000000000010000"
}

Аргумент options можно использовать для указания дополнительных опций для операции списка. См. документацию для Deno.KvListOptions для получения дополнительной информации.

Параметры типа

T = unknown

Параметры

selector: KvListSelector
необязательный
options: KvListOptions

Тип возвращаемого значения

KvListIterator<T>

© 2018–2024 the Deno authors
Licensed under the MIT License.
https://docs.deno.com/api/deno/~/Deno.Kv.prototype.list

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API