sqlalchemy.orm.interfaces

module documentation

Contains various base classes used throughout the ORM.

Defines some key base classes prominent within the internals.

This module and the classes within are mostly private, though some attributes are exposed when inspecting mappings.

Class ​Mapper​Property Represent a particular class attribute mapped by _orm.Mapper.
Class ​Prop​Comparator Defines SQL operators for .MapperProperty objects.
Constant EXT​_CONTINUE Undocumented
Constant EXT​_SKIP Undocumented
Constant EXT​_STOP Undocumented
Constant MANYTOMANY Undocumented
Constant MANYTOONE Undocumented
Constant NOT​_EXTENSION Undocumented
Constant ONETOMANY Undocumented
Class ​Compile​State​Option base for .ORMOption classes that affect the compilation of a SQL query and therefore need to be part of the cache key.
Class ​Criteria​Option Describe a WHERE criteria modification to an ORM statement at compilation time.
Class ​Loader​Option Describe a loader modification to an ORM statement at compilation time.
Class ​Loader​Strategy Describe the loading behavior of a StrategizedProperty object.
Class ​Mapper​Option Describe a modification to a Query
Class ​ORMColumns​Clause​Role Undocumented
Class ​ORMEntity​Columns​Clause​Role Undocumented
Class ​ORMFrom​Clause​Role Undocumented
Class ​ORMOption Base class for option objects that are passed to ORM queries.
Class ​ORMStatement​Role Undocumented
Class ​Strategized​Property A MapperProperty which uses selectable strategies to affect loading behavior.
Class ​User​Defined​Option Base class for a user-defined option that can be consumed from the .SessionEvents.do_orm_execute event hook.
EXT_CONTINUE =

Undocumented

Value
util.symbol('EXT_CONTINUE')
EXT_SKIP =

Undocumented

Value
util.symbol('EXT_SKIP')
EXT_STOP =

Undocumented

Value
util.symbol('EXT_STOP')
MANYTOMANY =

Undocumented

Value
util.symbol('MANYTOMANY',
            '''Indicates the many-to-many direction for a :func:`_orm.relationsh↵
ip`.

    This symbol is typically used by the internals but may be exposed within
    certain API features.

...
MANYTOONE =

Undocumented

Value
util.symbol('MANYTOONE',
            '''Indicates the many-to-one direction for a :func:`_orm.relationshi↵
p`.

    This symbol is typically used by the internals but may be exposed within
    certain API features.

...
NOT_EXTENSION =

Undocumented

Value
util.symbol('NOT_EXTENSION',
            '''Symbol indicating an :class:`InspectionAttr` that\'s
    not part of sqlalchemy.ext.

    Is assigned to the :attr:`.InspectionAttr.extension_type`
    attribute.

...
ONETOMANY =

Undocumented

Value
util.symbol('ONETOMANY',
            '''Indicates the one-to-many direction for a :func:`_orm.relationshi↵
p`.

    This symbol is typically used by the internals but may be exposed within
    certain API features.

...