Reference documentation and code samples for the Cloud Firestore V1beta1 Client class RunQueryRequest.
The request for Firestore.RunQuery.
Generated from protobuf message google.firestore.v1beta1.RunQueryRequest
Namespace
Google \ Cloud \ Firestore \ V1beta1
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
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.
Reads documents as they were at the given time. This may not be older than 60 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
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1beta1 Client - Class RunQueryRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1beta1.RunQueryRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1beta1.RunQueryRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1beta1.RunQueryRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1beta1.RunQueryRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1beta1.RunQueryRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1beta1.RunQueryRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1beta1.RunQueryRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1beta1.RunQueryRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1beta1.RunQueryRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1beta1.RunQueryRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1beta1.RunQueryRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1beta1.RunQueryRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1beta1.RunQueryRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1beta1.RunQueryRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1beta1.RunQueryRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1beta1.RunQueryRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1beta1.RunQueryRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1beta1.RunQueryRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1beta1.RunQueryRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1beta1.RunQueryRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1beta1.RunQueryRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1beta1.RunQueryRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1beta1.RunQueryRequest) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Cloud Firestore V1beta1 Client class RunQueryRequest.\n\nThe request for Firestore.RunQuery.\n\nGenerated from protobuf message `google.firestore.v1beta1.RunQueryRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1beta1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`\n\n### setParent\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`\n\n### getStructuredQuery\n\nA structured query.\n\n### setStructuredQuery\n\nA structured query.\n\n### getTransaction\n\nReads documents in a transaction.\n\n### setTransaction\n\nReads documents in a transaction.\n\n### getNewTransaction\n\nStarts a new transaction and reads the documents.\n\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.\n\n### setNewTransaction\n\nStarts a new transaction and reads the documents.\n\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.\n\n### getReadTime\n\nReads documents as they were at the given time.\n\nThis may not be older than 60 seconds.\n\n### setReadTime\n\nReads documents as they were at the given time.\n\nThis may not be older than 60 seconds.\n\n### getQueryType\n\n### getConsistencySelector"]]
