Method | Description | |
---|---|---|
__construct ( |
||
canPaginate ( ) : boolean | Indicate that this type does support automatic pagination. | |
distinctOn ( array | string $property ) : |
The properties to make distinct. | |
end ( string $cursor ) : |
The ending point for the query results. | |
filter ( string $property, string $operator, mixed $value ) : |
Add a filter to the query. | |
hasAncestor ( |
Query for entities by their ancestors. | |
jsonSerialize ( ) | ||
keysOnly ( ) : |
Set the query to return only keys (no properties). | |
kind ( array | string $kinds ) : |
Set the Kind to query. | |
limit ( integer $num ) : |
The number of results to return. | |
offset ( integer $num ) : |
The number of results to skip. | |
order ( string $property, string $direction = self::ORDER_DEFAULT ) : |
Specify an order for the query. | |
projection ( array | string $properties ) : |
Set the Query Projection. | |
queryKey ( ) : string | Return the query_type union field name. | |
queryObject ( ) : array | Return a service-compliant array. | |
start ( string $cursor ) : |
The starting point for the query results. |
Method | Description | |
---|---|---|
initializeFilter ( ) : void | Setup the filter object when the first filter is created. | |
mapOperator ( string $operator ) : string | Convert given operator to API-compatible operator. | |
propertyName ( string $property ) : array | Format a property name. |
public __construct ( |
||
$entityMapper | An instance of EntityMapper | |
$query | array | [optional] [Query](https://cloud.google.com/datastore/reference/rest/v1/projects/runQuery#query) |
public canPaginate ( ) : boolean | ||
return | boolean |
public distinctOn ( array | string $property ) : |
||
$property | array | string | The property or properties to make distinct. |
return |
public filter ( string $property, string $operator, mixed $value ) : |
||
$property | string | The property to filter. |
$operator | string | The operator to use in the filter. A list of allowed operators may be found [here](https://cloud.google.com/datastore/reference/rest/v1/projects/runQuery#operator_1). Short comparison operators are provided for convenience and are mapped to their datastore-compatible equivalents. Available short operators are `=`, `<`, `<=`, `>`, and `>=`. |
$value | mixed | The value to check. |
return |
public hasAncestor ( |
||
$key | The ancestor Key instance. | |
return |
public projection ( array | string $properties ) : |
||
$properties | array | string | The property or properties to include in the result. |
return |
public queryObject ( ) : array | ||
return | array |