Reference documentation and code samples for the Cloud Datastore V1 Client class Query.
A query for entities.
Generated from protobuf message google.datastore.v1.Query
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ projection |
array<Google\Cloud\Datastore\V1\Projection>
The projection to return. Defaults to returning all properties. |
↳ kind |
array<Google\Cloud\Datastore\V1\KindExpression>
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified. |
↳ filter |
Google\Cloud\Datastore\V1\Filter
The filter to apply. |
↳ order |
array<Google\Cloud\Datastore\V1\PropertyOrder>
The order to apply to the query results (if empty, order is unspecified). |
↳ distinct_on |
array<Google\Cloud\Datastore\V1\PropertyReference>
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). |
↳ start_cursor |
string
A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query. |
↳ end_cursor |
string
An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query. |
↳ offset |
int
The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified. |
↳ limit |
Google\Protobuf\Int32Value
The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. |
getProjection
The projection to return. Defaults to returning all properties.
Generated from protobuf field repeated .google.datastore.v1.Projection projection = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setProjection
The projection to return. Defaults to returning all properties.
Generated from protobuf field repeated .google.datastore.v1.Projection projection = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\Projection>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
The kinds to query (if empty, returns entities of all kinds).
Currently at most 1 kind may be specified.
Generated from protobuf field repeated .google.datastore.v1.KindExpression kind = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setKind
The kinds to query (if empty, returns entities of all kinds).
Currently at most 1 kind may be specified.
Generated from protobuf field repeated .google.datastore.v1.KindExpression kind = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\KindExpression>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
The filter to apply.
Generated from protobuf field .google.datastore.v1.Filter filter = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\Filter|null | |
hasFilter
clearFilter
setFilter
The filter to apply.
Generated from protobuf field .google.datastore.v1.Filter filter = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\Filter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrder
The order to apply to the query results (if empty, order is unspecified).
Generated from protobuf field repeated .google.datastore.v1.PropertyOrder order = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setOrder
The order to apply to the query results (if empty, order is unspecified).
Generated from protobuf field repeated .google.datastore.v1.PropertyOrder order = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\PropertyOrder>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDistinctOn
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).
Generated from protobuf field repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setDistinctOn
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).
Generated from protobuf field repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\PropertyReference>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartCursor
A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.
Generated from protobuf field bytes start_cursor = 7;
| Returns | |
|---|---|
| Type | Description |
string | |
setStartCursor
A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.
Generated from protobuf field bytes start_cursor = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndCursor
An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
Generated from protobuf field bytes end_cursor = 8;
| Returns | |
|---|---|
| Type | Description |
string | |
setEndCursor
An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.
Generated from protobuf field bytes end_cursor = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOffset
The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
Generated from protobuf field int32 offset = 10;
| Returns | |
|---|---|
| Type | Description |
int | |
setOffset
The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
Generated from protobuf field int32 offset = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLimit
The maximum number of results to return. Applies after all other constraints. Optional.
Unspecified is interpreted as no limit. Must be >= 0 if specified.
Generated from protobuf field .google.protobuf.Int32Value limit = 12;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int32Value|null | |
hasLimit
clearLimit
getLimitValue
Returns the unboxed value from getLimit()
The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
Generated from protobuf field .google.protobuf.Int32Value limit = 12;
| Returns | |
|---|---|
| Type | Description |
int|null | |
setLimit
The maximum number of results to return. Applies after all other constraints. Optional.
Unspecified is interpreted as no limit. Must be >= 0 if specified.
Generated from protobuf field .google.protobuf.Int32Value limit = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int32Value
|
| Returns | |
|---|---|
| Type | Description |
$this | |
setLimitValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
Generated from protobuf field .google.protobuf.Int32Value limit = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
int|null
|
| Returns | |
|---|---|
| Type | Description |
$this | |