Notice: Over the next few months, we're reorganizing the App Engine documentation site to make it easier to find content and better align with the rest of Google Cloud products. The same content will be available, but the navigation will now match the rest of the Cloud products. If you have feedback or questions as you navigate the site, click Send Feedback.

Python 2 is no longer supported by the community. We recommend that you migrate Python 2 apps to Python 3.

google.appengine.api.datastore_errors module


Errors used in the Python datastore API.


exception google.appengine.api.datastore_errors.BadArgumentErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by Query.Order(), Iterator.Next(), and others when they’re passed an invalid argument.

exception google.appengine.api.datastore_errors.BadFilterError(filter)source

Bases: google.appengine.api.datastore_errors.Error

Raised by Query.__setitem__() and Query.Run() when a filter string is invalid.

exception google.appengine.api.datastore_errors.BadKeyErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by Key.__str__ when the key is invalid.

exception google.appengine.api.datastore_errors.BadPropertyErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by Entity.__setitem__() when a property name isn’t a string.

exception google.appengine.api.datastore_errors.BadQueryErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by Query when a query or query string is invalid.

exception google.appengine.api.datastore_errors.BadRequestErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by datastore calls when the parameter(s) are invalid.

exception google.appengine.api.datastore_errors.BadValueErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by Entity.__setitem__(), Query.__setitem__(), Get(), and others when a property value or filter value is invalid.

exception google.appengine.api.datastore_errors.CommittedButStillApplyingsource

Bases: google.appengine.api.datastore_errors.Timeout

The write or transaction was committed, but some entities or index rows may not have been fully updated. Those updates should automatically be applied soon. You can roll them forward immediately by reading one of the entities inside a transaction.

exception google.appengine.api.datastore_errors.EntityNotFoundErrorsource

Bases: google.appengine.api.datastore_errors.Error

DEPRECATED: Raised by Get() when the requested entity is not found.

exception google.appengine.api.datastore_errors.Errorsource

Bases: exceptions.Exception

Base datastore error type.

exception google.appengine.api.datastore_errors.InternalErrorsource

Bases: google.appengine.api.datastore_errors.Error

An internal datastore error. Please report this to Google.

exception google.appengine.api.datastore_errors.NeedIndexError(error, original_message=None, header=None, yaml_index=None, xml_index=None)source

Bases: google.appengine.api.datastore_errors.Error

No matching index was found for a query that requires an index. Check the Indexes page in the Admin Console and your index.yaml file.

exception google.appengine.api.datastore_errors.QueryNotFoundErrorsource

Bases: google.appengine.api.datastore_errors.Error

DEPRECATED: Raised by Iterator methods when the Iterator is invalid. This should not happen during normal usage; it protects against malicious users and system errors.

exception google.appengine.api.datastore_errors.ReferencePropertyResolveErrorsource

Bases: google.appengine.api.datastore_errors.Error

An error occurred while trying to resolve a ReferenceProperty.

exception google.appengine.api.datastore_errors.Rollbacksource

Bases: google.appengine.api.datastore_errors.Error

May be raised by transaction functions when they want to roll back instead of committing. Note that any exception raised by a transaction function will cause a rollback. This is purely for convenience. See datastore.RunInTransaction for details.

exception google.appengine.api.datastore_errors.Timeoutsource

Bases: google.appengine.api.datastore_errors.Error

The datastore operation timed out, or the data was temporarily unavailable. This can happen when you attempt to put, get, or delete too many entities or an entity with too many properties, or if the datastore is overloaded or having trouble.

exception google.appengine.api.datastore_errors.TransactionFailedErrorsource

Bases: google.appengine.api.datastore_errors.Error

Raised by RunInTransaction methods when the transaction could not be committed, even after retrying. This is usually due to high contention.

exception google.appengine.api.datastore_errors.TransactionNotFoundErrorsource

Bases: google.appengine.api.datastore_errors.Error

DEPRECATED: Raised by RunInTransaction. This is an internal error; you should not see this.