SQLAlchemy 2.0 Documentation
SQLAlchemy ORM
- ORM Quick Start
- ORM Mapped Class Configuration
- Relationship Configuration
- ORM Querying Guide
- Using the Session
- Events and Internals
- ORM Extensions
- ORM Examples
Project Versions
- Previous: ORM Internals
- Next: ORM Extensions
- Up: Home
- On this page:
ORM Exceptions¶
SQLAlchemy ORM exceptions.
Object Name | Description |
---|---|
alias of |
|
Exception types that may be raised by instrumentation implementations. |
-
attribute
sqlalchemy.orm.exc..
sqlalchemy.orm.exc.ConcurrentModificationError¶ alias of
StaleDataError
- exception sqlalchemy.orm.exc.DetachedInstanceError¶
An attempt to access unloaded attributes on a mapped instance that is detached.
Class signature
class
sqlalchemy.orm.exc.DetachedInstanceError
(sqlalchemy.exc.SQLAlchemyError
)
- exception sqlalchemy.orm.exc.FlushError¶
A invalid condition was detected during flush().
Class signature
class
sqlalchemy.orm.exc.FlushError
(sqlalchemy.exc.SQLAlchemyError
)
- exception sqlalchemy.orm.exc.LoaderStrategyException¶
A loader strategy for an attribute does not exist.
Class signature
class
sqlalchemy.orm.exc.LoaderStrategyException
(sqlalchemy.exc.InvalidRequestError
)-
method
sqlalchemy.orm.exc.LoaderStrategyException.
__init__(applied_to_property_type: Type[Any], requesting_property: MapperProperty[Any], applies_to: Type[MapperProperty[Any]] | None, actual_strategy_type: Type[LoaderStrategy] | None, strategy_key: Tuple[Any, ...])¶
-
method
- sqlalchemy.orm.exc.NO_STATE = (<class 'AttributeError'>, <class 'KeyError'>)¶
Exception types that may be raised by instrumentation implementations.
- exception sqlalchemy.orm.exc.ObjectDeletedError¶
A refresh operation failed to retrieve the database row corresponding to an object’s known primary key identity.
A refresh operation proceeds when an expired attribute is accessed on an object, or when
Query.get()
is used to retrieve an object which is, upon retrieval, detected as expired. A SELECT is emitted for the target row based on primary key; if no row is returned, this exception is raised.The true meaning of this exception is simply that no row exists for the primary key identifier associated with a persistent object. The row may have been deleted, or in some cases the primary key updated to a new value, outside of the ORM’s management of the target object.
Class signature
class
sqlalchemy.orm.exc.ObjectDeletedError
(sqlalchemy.exc.InvalidRequestError
)-
method
sqlalchemy.orm.exc.ObjectDeletedError.
__init__(state: InstanceState[Any], msg: str | None = None)¶
-
method
- exception sqlalchemy.orm.exc.ObjectDereferencedError¶
An operation cannot complete due to an object being garbage collected.
Class signature
class
sqlalchemy.orm.exc.ObjectDereferencedError
(sqlalchemy.exc.SQLAlchemyError
)
- exception sqlalchemy.orm.exc.StaleDataError¶
An operation encountered database state that is unaccounted for.
Conditions which cause this to happen include:
A flush may have attempted to update or delete rows and an unexpected number of rows were matched during the UPDATE or DELETE statement. Note that when version_id_col is used, rows in UPDATE or DELETE statements are also matched against the current known version identifier.
A mapped object with version_id_col was refreshed, and the version number coming back from the database does not match that of the object itself.
A object is detached from its parent object, however the object was previously attached to a different parent identity which was garbage collected, and a decision cannot be made if the new parent was really the most recent “parent”.
Class signature
class
sqlalchemy.orm.exc.StaleDataError
(sqlalchemy.exc.SQLAlchemyError
)
- exception sqlalchemy.orm.exc.UnmappedClassError¶
An mapping operation was requested for an unknown class.
Class signature
class
sqlalchemy.orm.exc.UnmappedClassError
(sqlalchemy.orm.exc.UnmappedError
)-
method
sqlalchemy.orm.exc.UnmappedClassError.
__init__(cls: Type[_T], msg: str | None = None)¶
-
method
- exception sqlalchemy.orm.exc.UnmappedColumnError¶
Mapping operation was requested on an unknown column.
Class signature
class
sqlalchemy.orm.exc.UnmappedColumnError
(sqlalchemy.exc.InvalidRequestError
)
- exception sqlalchemy.orm.exc.UnmappedError¶
Base for exceptions that involve expected mappings not present.
Class signature
class
sqlalchemy.orm.exc.UnmappedError
(sqlalchemy.exc.InvalidRequestError
)
- exception sqlalchemy.orm.exc.UnmappedInstanceError¶
An mapping operation was requested for an unknown instance.
Class signature
class
sqlalchemy.orm.exc.UnmappedInstanceError
(sqlalchemy.orm.exc.UnmappedError
)-
method
sqlalchemy.orm.exc.UnmappedInstanceError.
__init__(obj: object, msg: str | None = None)¶
-
method
flambé! the dragon and The Alchemist image designs created and generously donated by Rotem Yaari.
Created using Sphinx 7.2.6. Documentation last generated: Thu 12 Dec 2024 05:39:06 PM EST