Cloud Datastore V1 Client - Class Count (1.23.0)

Version 1.23.0

• 1.32.0 (latest)
• 1.31.0
• 1.30.0
• 1.29.2
• 1.28.2
• 1.26.0
• 1.25.0
• 1.24.4
• 1.23.0
• 1.22.1
• 1.21.2
• 1.19.0
• 1.18.1
• 1.17.1

Reference documentation and code samples for the Cloud Datastore V1 Client class Count.

Count of entities that match the query.

The COUNT(*) aggregation function operates on the entire entity so it does not require a field reference.

Generated from protobuf message google.datastore.v1.AggregationQuery.Aggregation.Count

Namespace

Google \ Cloud \ Datastore \ V1 \ AggregationQuery \ Aggregation

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ up_to	Google\Protobuf\Int64Value Optional. Optional constraint on the maximum number of entities to count. This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example: AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); Requires: * Must be non-negative when present.

getUpTo

Optional. Optional constraint on the maximum number of entities to count.

This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Requires:

• Must be non-negative when present.

Returns
Type	Description
Google\Protobuf\Int64Value|null

hasUpTo

clearUpTo

getUpToValue

Returns the unboxed value from getUpTo()

Optional. Optional constraint on the maximum number of entities to count. This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Requires:

• Must be non-negative when present.

Returns
Type	Description
int|string|null

setUpTo

Optional. Optional constraint on the maximum number of entities to count.

This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Requires:

• Must be non-negative when present.

Parameter
Name	Description
var	Google\Protobuf\Int64Value

Returns
Type	Description
$this

setUpToValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

Optional. Optional constraint on the maximum number of entities to count. This provides a way to set an upper bound on the number of entities to scan, limiting latency, and cost. Unspecified is interpreted as no bound. If a zero value is provided, a count result of zero should always be expected. High-Level Example:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Requires:

• Must be non-negative when present.

Parameter
Name	Description
var	int|string|null

Returns
Type	Description
$this