Cloud Datastore Client - Class Query (1.17.1)

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

Represents a Cloud Datastore Query

Queries can be created either by using the builder pattern, or by providing a Query when creating this object.

Example:

 use Google\Cloud\Datastore\DatastoreClient;

$datastore = new DatastoreClient();

$query = $datastore->query();
$query->kind('Companies');
$query->filter('companyName', '=', 'Google');

$res = $datastore->runQuery($query);
foreach ($res as $company) {
    echo $company['companyName']; // Google
} 

 // Queries can also be constructed using a
// [Query Object](https://cloud.google.com/datastore/reference/rest/v1/projects/runQuery#query):
$query = $datastore->query([
    'query' => [
        'kind' => [
            [
                'name' => 'Companies'
            ]
        ],
        'filter' => [
            'propertyFilter' => [
                'op' => 'EQUAL',
                'property' => [
                    'name' => 'companyName'
                ],
                'value' => [
                    'stringValue' => 'Google'
                ]
            ]
        ]
    ]
]); 

Set the Query Projection.

Accepts an array of properties. If set, only these properties will be returned.

Example:

 $query->projection(['firstName', 'lastName']); 

Set the query to return only keys (no properties).

Example:

 $query->keysOnly(); 

Set the Kind to query.

If empty, returns entities of all kinds. Must be set in order to filter results. While you may supply as many kinds as you wish, datastore currently only accepts one at a time.

Example:

 $query->kind('Person'); 

Add a filter to the query.

If the top-level filter is specified as a propertyFilter, it will be replaced. Any composite filters will be preserved and the new filter will be added.

Example:

 $query->filter('firstName', '=', 'Bob')
    ->filter('lastName', '=', 'Testguy'); 

Query for entities by their ancestors.

Keys can be provided either via a {@see} object, or by providing a kind, identifier and (optionally) an identifier type.

Example:

 $key = $datastore->key('Person', 'Bob');
$query->hasAncestor($key); 

 // Specifying an identifier type
$key = $datastore->key('Robots', '1337', [
    'identifierType' => Key::TYPE_NAME
]);
$query->hasAncestor($key); 

Specify an order for the query.

Example:

 $query->order('birthDate', Query::ORDER_DESCENDING); 

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).

Example:

 $query->distinctOn('lastName'); 

The starting point for the query results.

Example:

 $query->start($lastResultCursor); 

The ending point for the query results.

Example:

 $query->end($lastResultCursor); 

The number of results to skip.

Example:

 $query->offset(2); 

The number of results to return.

Example:

 $query->limit(50); 

Indicate that this type does support automatic pagination.

Return a service-compliant array.

This method is intended for use internally by the PHP client.

Return the query_type union field name.