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
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 |
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.
When true, selects all descendant collections.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |