Skip to main content
Module

x/google_datastore/types.d.ts>QueryResultBatch

A set of APIs that allow interfacing to Google Datastore on GCP from Deno.
kitsonk/google-datastore
Go to Latest
interface QueryResultBatch
import { type QueryResultBatch } from "https://deno.land/x/google_datastore@0.0.14/types.d.ts";

A batch of results produced by a query.

Properties

endCursor: string

A cursor that points to the position after the last result in the batch.

entityResultType:
| "RESULT_TYPE_UNSPECIFIED"
| "FULL"
| "PROJECTION"
| "KEY_ONLY"

The result type for every entity in entity_results.

optional
entityResults: EntityResult[]

The results for this batch.

moreResults:
| "MORE_RESULTS_TYPE_UNSPECIFIED"
| "NOT_FINISHED"
| "MORE_RESULTS_AFTER_LIMIT"
| "MORE_RESULTS_AFTER_CURSOR"
| "NO_MORE_RESULTS"

The state of the query after the current batch.

optional
skippedCursor: string

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.

optional
skippedResults: number

The number of results skipped, typically because of an offset.

snapshotVersion: string

The version number of the snapshot this batch was returned from.

This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor).

In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches.

The value will be zero for eventually consistent queries.