Cloud Firestore V1 Client - Class RunQueryRequest (1.40.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class RunQueryRequest.

The request for Firestore.RunQuery.

Generated from protobuf message google.firestore.v1.RunQueryRequest

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
`↳ structured_query`	`Google\Cloud\Firestore\V1\StructuredQuery` A structured query.
`↳ transaction`	`string` Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.
`↳ new_transaction`	`Google\Cloud\Firestore\V1\TransactionOptions` Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
`↳ read_time`	`Google\Protobuf\Timestamp` Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
`↳ mode`	`int` Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results.

getParent

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}.

For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Returns
Type	Description
`string`

setParent

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}.

For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStructuredQuery

A structured query.

Returns
Type	Description
`Google\Cloud\Firestore\V1\StructuredQuery\|null`

hasStructuredQuery

setStructuredQuery

A structured query.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\StructuredQuery`

Returns
Type	Description
`$this`

getTransaction

Run the query within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Returns
Type	Description
`string`

hasTransaction

setTransaction

Run the query within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNewTransaction

Starts a new transaction and reads the documents.

Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

Returns
Type	Description
`Google\Cloud\Firestore\V1\TransactionOptions\|null`

hasNewTransaction

setNewTransaction

Starts a new transaction and reads the documents.

Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.

Parameter
Name	Description
`var`	`Google\Cloud\Firestore\V1\TransactionOptions`

Returns
Type	Description
`$this`

getReadTime

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasReadTime

setReadTime

Reads documents as they were at the given time.

This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getMode

Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to NORMAL mode where no additional statistics will be returned with the query results.

Returns
Type	Description
`int`

setMode

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getQueryType

Returns
Type	Description
`string`

getConsistencySelector

Returns
Type	Description
`string`