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
Methods
__construct
Constructor.
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
↳ 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 may not be older than 270 seconds.
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
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
var
string
$this
getStructuredQuery
A structured query.
hasStructuredQuery
setStructuredQuery
A structured query.
$this
getTransaction
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
string
hasTransaction
setTransaction
Run the query within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
var
string
$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.
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.
$this
getReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
hasReadTime
setReadTime
Reads documents as they were at the given time.
This may not be older than 270 seconds.
$this
getQueryType
string
getConsistencySelector
string
