Udostępnij za pośrednictwem

QueryIterator class

  • Odwołanie
Pakiet:
@azure/cosmos

Reprezentuje obiekt QueryIterator, implementację kanału informacyjnego lub odpowiedzi na zapytanie, która umożliwia przechodzenie i iterowanie odpowiedzi w usłudze bazy danych Azure Cosmos DB.

Metody

fetchAll()

Pobierz wszystkie strony dla zapytania i zwróć pojedynczą wartość FeedResponse.
fetchNext()

Pobierz następną partię ze źródła danych.

Może to spowodować pobranie większej liczby stron z zaplecza w zależności od ustawień i typu zapytania. Zapytania agregujące zazwyczaj pobierają wszystkie strony zaplecza przed zwróceniem pierwszej partii odpowiedzi.
getAsyncIterator()

Pobiera iterator asynchroniczny, który przyniesie wyniki do momentu ukończenia.

UWAGA: AsyncIterators to bardzo nowa funkcja i może być konieczne użycie polifilów itp. w celu ich użycia w kodzie.

Jeśli używasz języka TypeScript, możesz użyć następującego wielowypełniania, o ile jest on przeznaczony dla wersji ES6 lub nowszej i działa w węźle 6 lub nowszym.

if (!Symbol || !Symbol.asyncIterator) {
  (Symbol as any).asyncIterator = Symbol.for("Symbol.asyncIterator");
}

Przykład

Iterowanie we wszystkich bazach danych

for await(const { resources: db } of client.databases.readAll().getAsyncIterator()) {
  console.log(`Got ${db} from AsyncIterator`);
}
hasMoreResults()

Ustal, czy nadal istnieją zasoby do przetworzenia na podstawie wartości tokenu kontynuacji lub elementów pozostałych w bieżącej partii w usłudze QueryIterator.
reset()

Zresetuj element QueryIterator na początku i wyczyść wszystkie zasoby w nim

Szczegóły metody

fetchAll()

Pobierz wszystkie strony dla zapytania i zwróć pojedynczą wartość FeedResponse.

function fetchAll(): Promise<FeedResponse<T>>

Zwraca

Promise<FeedResponse<T>>

fetchNext()

Pobierz następną partię ze źródła danych.

Może to spowodować pobranie większej liczby stron z zaplecza w zależności od ustawień i typu zapytania. Zapytania agregujące zazwyczaj pobierają wszystkie strony zaplecza przed zwróceniem pierwszej partii odpowiedzi.

function fetchNext(): Promise<FeedResponse<T>>

Zwraca

Promise<FeedResponse<T>>

getAsyncIterator()

Pobiera iterator asynchroniczny, który przyniesie wyniki do momentu ukończenia.

UWAGA: AsyncIterators to bardzo nowa funkcja i może być konieczne użycie polifilów itp. w celu ich użycia w kodzie.

Jeśli używasz języka TypeScript, możesz użyć następującego wielowypełniania, o ile jest on przeznaczony dla wersji ES6 lub nowszej i działa w węźle 6 lub nowszym.

if (!Symbol || !Symbol.asyncIterator) {
  (Symbol as any).asyncIterator = Symbol.for("Symbol.asyncIterator");
}

Przykład

Iterowanie we wszystkich bazach danych

for await(const { resources: db } of client.databases.readAll().getAsyncIterator()) {
  console.log(`Got ${db} from AsyncIterator`);
}

function getAsyncIterator(): AsyncIterable<FeedResponse<T>>

Zwraca

AsyncIterable<FeedResponse<T>>

hasMoreResults()

Ustal, czy nadal istnieją zasoby do przetworzenia na podstawie wartości tokenu kontynuacji lub elementów pozostałych w bieżącej partii w usłudze QueryIterator.

function hasMoreResults(): boolean

Zwraca

boolean

wartość true, jeśli istnieją inne elementy do przetworzenia w obiekcie QueryIterator.

reset()

Zresetuj element QueryIterator na początku i wyczyść wszystkie zasoby w nim

function reset()