Reference documentation and code samples for the Cloud Firestore V1 Client class CollectionSelector.
A selection of a collection, such as messages as m1.
Generated from protobuf message google.firestore.v1.StructuredQuery.CollectionSelector
Namespace
Google \ Cloud \ Firestore \ V1 \ StructuredQuery
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ collection_id
string
The collection ID. When set, selects only collections with this ID.
↳ all_descendants
bool
When false, selects only collections that are immediate children of the parent specified in the containing RunQueryRequest. When true, selects all descendant collections.
getCollectionId
The collection ID.
When set, selects only collections with this ID.
Returns
Type
Description
string
setCollectionId
The collection ID.
When set, selects only collections with this ID.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAllDescendants
When false, selects only collections that are immediate children of
the parent specified in the containing RunQueryRequest.
When true, selects all descendant collections.
Returns
Type
Description
bool
setAllDescendants
When false, selects only collections that are immediate children of
the parent specified in the containing RunQueryRequest.
[[["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 V1 Client - Class CollectionSelector (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/V1.StructuredQuery.CollectionSelector)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/V1.StructuredQuery.CollectionSelector)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/V1.StructuredQuery.CollectionSelector)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/V1.StructuredQuery.CollectionSelector)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/V1.StructuredQuery.CollectionSelector)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/V1.StructuredQuery.CollectionSelector)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/V1.StructuredQuery.CollectionSelector)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/V1.StructuredQuery.CollectionSelector)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/V1.StructuredQuery.CollectionSelector)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/V1.StructuredQuery.CollectionSelector)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/V1.StructuredQuery.CollectionSelector)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/V1.StructuredQuery.CollectionSelector)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/V1.StructuredQuery.CollectionSelector)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/V1.StructuredQuery.CollectionSelector)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/V1.StructuredQuery.CollectionSelector)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/V1.StructuredQuery.CollectionSelector)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/V1.StructuredQuery.CollectionSelector)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/V1.StructuredQuery.CollectionSelector)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/V1.StructuredQuery.CollectionSelector)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/V1.StructuredQuery.CollectionSelector)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/V1.StructuredQuery.CollectionSelector)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/V1.StructuredQuery.CollectionSelector)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/V1.StructuredQuery.CollectionSelector) \nReference documentation and code samples for the Cloud Firestore V1 Client class CollectionSelector.\n\nA selection of a collection, such as `messages as m1`.\n\nGenerated from protobuf message `google.firestore.v1.StructuredQuery.CollectionSelector`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ V1 \\\\ StructuredQuery\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCollectionId\n\nThe collection ID.\n\nWhen set, selects only collections with this ID.\n\n### setCollectionId\n\nThe collection ID.\n\nWhen set, selects only collections with this ID.\n\n### getAllDescendants\n\nWhen false, selects only collections that are immediate children of\nthe `parent` specified in the containing `RunQueryRequest`.\n\nWhen true, selects all descendant collections.\n\n### setAllDescendants\n\nWhen false, selects only collections that are immediate children of\nthe `parent` specified in the containing `RunQueryRequest`.\n\nWhen true, selects all descendant collections."]]
