QueryIterator class

  • Referencia
Paquete:
@azure/cosmos

Representa un objeto QueryIterator, una implementación de la respuesta de fuente o consulta que permite recorrer y recorrer en iteración la respuesta en el servicio de base de datos de Azure Cosmos DB.

Métodos

fetchAll()

Capture todas las páginas de la consulta y devuelva una sola feedResponse.
fetchNext()

Recupere el siguiente lote de la fuente.

Esto puede capturar o no más páginas del back-end en función de la configuración y el tipo de consulta. Las consultas agregadas generalmente capturarán todas las páginas de back-end antes de devolver el primer lote de respuestas.
getAsyncIterator()

Obtiene un iterador asincrónico que producirá resultados hasta la finalización.

NOTA: AsyncIterators es una característica muy nueva y es posible que tenga que usar polyfils/etc. para usarlos en el código.

Si usa TypeScript, puede usar el siguiente polyfill siempre que tenga como destino ES6 o superior y se ejecute en el nodo 6 o superior.

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

Ejemplo

Iterar por todas las bases de datos

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

Determine si todavía hay recursos restantes para procesar en función del valor del token de continuación o de los elementos restantes en el lote actual en QueryIterator.
reset()

Restablezca QueryIterator al principio y borre todos los recursos que contiene.

Detalles del método

fetchAll()

Capture todas las páginas de la consulta y devuelva una sola feedResponse.

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

Devoluciones

Promise<FeedResponse<T>>

fetchNext()

Recupere el siguiente lote de la fuente.

Esto puede capturar o no más páginas del back-end en función de la configuración y el tipo de consulta. Las consultas agregadas generalmente capturarán todas las páginas de back-end antes de devolver el primer lote de respuestas.

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

Devoluciones

Promise<FeedResponse<T>>

getAsyncIterator()

Obtiene un iterador asincrónico que producirá resultados hasta la finalización.

NOTA: AsyncIterators es una característica muy nueva y es posible que tenga que usar polyfils/etc. para usarlos en el código.

Si usa TypeScript, puede usar el siguiente polyfill siempre que tenga como destino ES6 o superior y se ejecute en el nodo 6 o superior.

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

Ejemplo

Iterar por todas las bases de datos

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

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

Devoluciones

AsyncIterable<FeedResponse<T>>

hasMoreResults()

Determine si todavía hay recursos restantes para procesar en función del valor del token de continuación o de los elementos restantes en el lote actual en QueryIterator.

function hasMoreResults(): boolean

Devoluciones

boolean

True si hay otros elementos que se van a procesar en QueryIterator.

reset()

Restablezca QueryIterator al principio y borre todos los recursos que contiene.

function reset()