QueryResultBatch

import type { QueryResultBatch } from "https://googleapis.deno.dev/v1/datastore:v1.ts";

A batch of results produced by a query.

interface QueryResultBatch {

endCursor?: Uint8Array;

entityResults?: EntityResult[];

entityResultType?:

| "RESULT_TYPE_UNSPECIFIED"

| "FULL"

| "PROJECTION"

| "KEY_ONLY";

moreResults?:

| "MORE_RESULTS_TYPE_UNSPECIFIED"

| "NOT_FINISHED"

| "MORE_RESULTS_AFTER_LIMIT"

| "MORE_RESULTS_AFTER_CURSOR"

| "NO_MORE_RESULTS";

readTime?: Date;

skippedCursor?: Uint8Array;

skippedResults?: number;

snapshotVersion?: bigint;

}

§Properties

endCursor?: Uint8Array

[src]

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

entityResults?: EntityResult[]

[src]

The results for this batch.

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

[src]

The result type for every entity in entity_results.

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

[src]

The state of the query after the current batch.

readTime?: Date

[src]

Read timestamp 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 timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.

skippedCursor?: Uint8Array

[src]

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

skippedResults?: number

[src]

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

snapshotVersion?: bigint

[src]

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.