Reference documentation and code samples for the Cloud Datastore V1 Client class RunAggregationQueryRequest.
The request for Datastore.RunAggregationQuery.
Generated from protobuf message google.datastore.v1.RunAggregationQueryRequest
Namespace
Google \ Cloud \ Datastore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. The ID of the project against which to make the request. |
↳ database_id |
string
The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. |
↳ partition_id |
PartitionId
Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. |
↳ read_options |
ReadOptions
The options for this query. |
↳ aggregation_query |
AggregationQuery
The query to run. |
↳ gql_query |
GqlQuery
The GQL query to run. This query must be an aggregation query. |
↳ explain_options |
ExplainOptions
Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. |
getProjectId
Required. The ID of the project against which to make the request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setProjectId
Required. The ID of the project against which to make the request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseId
The ID of the database against which to make the request.
'(default)' is not allowed; please use empty string '' to refer the default database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseId
The ID of the database against which to make the request.
'(default)' is not allowed; please use empty string '' to refer the default database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartitionId
Entities are partitioned into subsets, identified by a partition ID.
Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
| Returns | |
|---|---|
| Type | Description |
PartitionId|null |
|
hasPartitionId
clearPartitionId
setPartitionId
Entities are partitioned into subsets, identified by a partition ID.
Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID.
| Parameter | |
|---|---|
| Name | Description |
var |
PartitionId
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReadOptions
The options for this query.
| Returns | |
|---|---|
| Type | Description |
ReadOptions|null |
|
hasReadOptions
clearReadOptions
setReadOptions
The options for this query.
| Parameter | |
|---|---|
| Name | Description |
var |
ReadOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAggregationQuery
The query to run.
| Returns | |
|---|---|
| Type | Description |
AggregationQuery|null |
|
hasAggregationQuery
setAggregationQuery
The query to run.
| Parameter | |
|---|---|
| Name | Description |
var |
AggregationQuery
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGqlQuery
The GQL query to run. This query must be an aggregation query.
| Returns | |
|---|---|
| Type | Description |
GqlQuery|null |
|
hasGqlQuery
setGqlQuery
The GQL query to run. This query must be an aggregation query.
| Parameter | |
|---|---|
| Name | Description |
var |
GqlQuery
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExplainOptions
Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
| Returns | |
|---|---|
| Type | Description |
ExplainOptions|null |
|
hasExplainOptions
clearExplainOptions
setExplainOptions
Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
| Parameter | |
|---|---|
| Name | Description |
var |
ExplainOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryType
| Returns | |
|---|---|
| Type | Description |
string |
|