sqlalchemy.orm.base.PassiveFlag

class documentation

class PassiveFlag(FastIntFlag): (source)

View In Hierarchy

Bitflag interface that passes options onto loader callables

Constant CALLABLES_OK Loader callables can be fired off if a value is not present.
Constant DEFERRED_HISTORY_LOAD indicates special load of the previous value of an attribute
Constant INIT_OK Attributes should be initialized with a blank value (None or an empty collection) upon get, if no other value can be obtained.
Constant LOAD_AGAINST_COMMITTED Callables should use committed values as primary/foreign keys during a load.
Constant NO_AUTOFLUSH Undocumented
Constant NO_CHANGE No callables or SQL should be emitted on attribute access and no state should change
Constant NO_RAISE Loader callables should not raise any assertions
Constant NON_PERSISTENT_OK Callables can be emitted if the parent is not persistent.
Constant PASSIVE_MERGE PASSIVE_OFF | NO_RAISE
Constant PASSIVE_NO_FETCH PASSIVE_OFF ^ SQL_OK
Constant PASSIVE_NO_FETCH_RELATED PASSIVE_OFF ^ RELATED_OBJECT_OK
Constant PASSIVE_NO_INITIALIZE PASSIVE_RETURN_NO_VALUE ^ CALLABLES_OK
Constant PASSIVE_OFF Callables can be emitted in all cases.
Constant PASSIVE_ONLY_PERSISTENT PASSIVE_OFF ^ NON_PERSISTENT_OK
Constant PASSIVE_RETURN_NO_VALUE PASSIVE_OFF ^ INIT_OK
Constant RELATED_OBJECT_OK Callables can use SQL to load related objects as well as scalar value attributes.
Constant SQL_OK Loader callables can emit SQL at least on scalar value attributes.
CALLABLES_OK: int = (source)

Loader callables can be fired off if a value is not present.

Value
1
DEFERRED_HISTORY_LOAD: int = (source)

indicates special load of the previous value of an attribute

Value
256
INIT_OK: int = (source)

Attributes should be initialized with a blank value (None or an empty collection) upon get, if no other value can be obtained.

Value
8
LOAD_AGAINST_COMMITTED: int = (source)

Callables should use committed values as primary/foreign keys during a load.

Value
32
NO_AUTOFLUSH: int = (source)

Undocumented

Value
64
NO_CHANGE: int = (source)

No callables or SQL should be emitted on attribute access and no state should change

Value
0
NO_RAISE: int = (source)

Loader callables should not raise any assertions

Value
128
NON_PERSISTENT_OK: int = (source)

Callables can be emitted if the parent is not persistent.

Value
16
PASSIVE_MERGE = (source)

PASSIVE_OFF | NO_RAISE Symbol used specifically for session.merge() and similar cases

Value
PASSIVE_OFF|NO_RAISE
PASSIVE_NO_FETCH = (source)

PASSIVE_OFF ^ SQL_OK

Value
PASSIVE_OFF^SQL_OK
PASSIVE_NO_FETCH_RELATED = (source)

PASSIVE_OFF ^ RELATED_OBJECT_OK

Value
PASSIVE_OFF^RELATED_OBJECT_OK
PASSIVE_NO_INITIALIZE = (source)

PASSIVE_RETURN_NO_VALUE ^ CALLABLES_OK

Value
PASSIVE_RETURN_NO_VALUE^CALLABLES_OK
PASSIVE_OFF = (source)

Callables can be emitted in all cases.

Value
(((RELATED_OBJECT_OK|NON_PERSISTENT_OK)|INIT_OK)|CALLABLES_OK)|SQL_OK
PASSIVE_ONLY_PERSISTENT = (source)

PASSIVE_OFF ^ NON_PERSISTENT_OK

Value
PASSIVE_OFF^NON_PERSISTENT_OK
PASSIVE_RETURN_NO_VALUE = (source)

PASSIVE_OFF ^ INIT_OK

Value
PASSIVE_OFF^INIT_OK
RELATED_OBJECT_OK: int = (source)

Callables can use SQL to load related objects as well as scalar value attributes.

Value
4
SQL_OK: int = (source)

Loader callables can emit SQL at least on scalar value attributes.

Value
2