Migrating Google Datastore from V1 to V2

How to upgrade

Update yourgoogle/cloud-datastore dependency to^2.0:

{    "require": {        "google/cloud-datastore": "^2.0"    }}

Breaking Changes

EntityInterface changes

Types have been added to the methods inEntityInterface. This means thatany classes implementing this interface will need to be updated to match the new method signatures:

 class Business implements EntityInterface {     use EntityTrait;-     public static function mappings()+     public static function mappings(): array     {         return [             'parent' => Business::class         ];     } }

Client Options changes

The followingClientOptions have been reorganized. This wasdone to ensure client options are consistent across all Google Cloud clients.

  • authCache -> Moved tocredentialsConfig.authCache
  • authCacheOptions -> Moved tocredentialsConfig.authCacheOptions
  • credentialsFetcher -> Moved tocredentials
  • keyFile -> Moved tocredentials
  • keyFilePath -> Moved tocredentials
  • requestTimeout -> Removed from client options and moved to a call optiontimeoutMillis
  • scopes -> Moved tocredentialsConfig.scopes
  • defaultScopes -> Moved tocredentialsConfig.defaultScopes
  • quotaProject -> Moved tocredentialsConfig.quotaProject
  • httpHandler -> Moved totransportConfig.rest.httpHandler
  • authHttpHandler -> Moved tocredentialsConfig.authHttpHandler
  • asyncHttpHandler -> Removed in favor of a single httpHandler option.
  • restOptions -> Moved totransportConfig.rest
  • grpcOptions -> Moved totransportConfig.grpc
  • accessToken -> Removed - This option is no longer supported. Use the$credentialsFetcher option instead.
  • shouldSignRequest -> Removed - obsolete
  • preferNumericProjectId -> Removed - obsolete

Retry Options changes

The retry options have been moved to useRetrySettings in Client Options and incall options.

  • retries -> Renamed toretrySettings.maxRetries
  • restRetryFunction -> Renamed toretrySettings.retryFunction
  • grpcRetryFunction -> Renamed toretrySettings.retryFunction
  • delayFunc/calcDelayFunction -> Removed in favor of the propertiesretrySettings.initialRetryDelayMillis,retrySettings.retryDelayMultiplier andretrySettings.maxRetryDelayMillis.

Internal changes

We expect these changes to not break existing code, as they have been done inclasses marked@internal or as part of refactoring, but to be safe, thesechanges have been released in a major version.

Types for properties, parameters, and return types.

Types have been added for all properties, parameters and return types. This means that any classesimplementing interfaces in this library (specifically,EntityInterface as mentioned above),will need to be updated to match the new method signatures. Typing constraints may have other effectswhere the incorrect types had been previously applied.

Options array validation

Previously, if unrecognized array keys were passed into methods, these additional arguments wouldbe ignored. Now, aLogicException will be thrown in theOptionsValidator class with the message"Unexpected option(s) provided: [OPTION-NAME]". If you see this exception, and you believe it to bean error, please file an issue in thegoogle-cloud-php repo and let usknow.

Connection classes are not used anymore.

The following classes are removed, and have been replaced with the generatedGAPIC clientGoogle\Cloud\Datastore\V1\Client\DatastoreClient:

  • Google\Cloud\Datastore\Connection\ConnectionInterface is removed
  • Google\Cloud\Datastore\Connection\Rest is removed
  • Google\Cloud\Datastore\Connection\Grpc is removed

Additionally, the previously generated GAPIC client(Google\Cloud\Datastore\V1\DatastoreClient, which has a similar name toGoogle\Cloud\Datastore\V1\Client\DatastoreClient, but without theClientnamespace) has been removed. For more information, seeMigrating to V2.

Constants inQuery\Query have been changed from string to int

These constants are used internally, but if they are being used in any code, they will need to beupdated:

  • Google\Cloud\Datastore\Query\Query::OP_DEFAULT changed from'EQUAL' to5
  • Google\Cloud\Datastore\Query\Query::OP_LESS_THAN changed from'LESS_THAN' to1
  • Google\Cloud\Datastore\Query\Query::OP_LESS_THAN_OR_EQUAL changed from'LESS_THAN_OR_EQUAL' to2
  • Google\Cloud\Datastore\Query\Query::OP_GREATER_THAN changed from'GREATER_THAN' to3
  • Google\Cloud\Datastore\Query\Query::OP_GREATER_THAN_OR_EQUAL changed from'GREATER_THAN_OR_EQUAL' to4
  • Google\Cloud\Datastore\Query\Query::OP_EQUALS changed from'EQUAL' to5
  • Google\Cloud\Datastore\Query\Query::OP_NOT_EQUALS changed from'NOT_EQUAL' to9
  • Google\Cloud\Datastore\Query\Query::OP_IN changed from'IN' to6
  • Google\Cloud\Datastore\Query\Query::OP_NOT_IN changed from'NOT_IN' to13
  • Google\Cloud\Datastore\Query\Query::OP_HAS_ANCESTOR changed from'HAS_ANCESTOR' to11
  • Google\Cloud\Datastore\Query\Query::ORDER_DEFAULT changed from'ASCENDING' to1
  • Google\Cloud\Datastore\Query\Query::ORDER_DESCENDING changed from'DESCENDING' to2
  • Google\Cloud\Datastore\Query\Query::ORDER_ASCENDING changed from'ASCENDING' to1

Protobuf backwards compatibility files have been removed

These class aliases have been deprecated for a very long time, and are finally being removed. Updateto the namespaced version (replacing_ with\) to upgrade.

  • Google\Cloud\Datastore\V1\PropertyFilter_Operator has been removed
  • Google\Cloud\Datastore\V1\EntityResult_ResultType has been removed
  • Google\Cloud\Datastore\V1\CommitRequest_Mode has been removed
  • Google\Cloud\Datastore\V1\CompositeFilter_Operator has been removed
  • Google\Cloud\Datastore\V1\TransactionOptions_ReadWrite has been removed
  • Google\Cloud\Datastore\V1\QueryResultBatch_MoreResultsType has been removed
  • Google\Cloud\Datastore\V1\TransactionOptions_ReadOnly has been removed
  • Google\Cloud\Datastore\V1\PropertyOrder_Direction has been removed
  • Google\Cloud\Datastore\V1\AggregationQuery_Aggregation has been removed
  • Google\Cloud\Datastore\V1\ReadOptions_ReadConsistency has been removed
  • Google\Cloud\Datastore\V1\Key_PathElement has been removed
  • Google\Cloud\Datastore\V1\AggregationQuery_Aggregation_Count has been removed

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-24 UTC.