Participer au site avec un Tip
Rechercher
 

Améliorations / Corrections

Vous avez des améliorations (ou des corrections) à proposer pour ce document : je vous remerçie par avance de m'en faire part, cela m'aide à améliorer le site.

Emplacement :

Description des améliorations :

Contenu du module « sqlalchemy.orm »

Liste des classes du module sqlalchemy.orm

Nom de la classe Description
AliasOption
AppenderQuery A dynamic query that supports basic collection storage operations. [extrait de AppenderQuery.__doc__]
AttributeEvent A token propagated throughout the course of a chain of attribute [extrait de AttributeEvent.__doc__]
AttributeEvents Define events for object attributes. [extrait de AttributeEvents.__doc__]
AttributeState Provide an inspection interface corresponding [extrait de AttributeState.__doc__]
Bundle A grouping of SQL expressions that are returned by a :class:`.Query` [extrait de Bundle.__doc__]
CascadeOptions Keeps track of the options sent to [extrait de CascadeOptions.__doc__]
ClassManager Tracks state information at the class level. [extrait de ClassManager.__doc__]
ColumnProperty Describes an object attribute that corresponds to a table column. [extrait de ColumnProperty.__doc__]
CompositeProperty Defines a "composite" mapped attribute, representing a collection [extrait de CompositeProperty.__doc__]
DeclarativeMeta
declared_attr Mark a class-level method as representing the definition of [extrait de declared_attr.__doc__]
FromStatement Core construct that represents a load of ORM objects from a finished [extrait de FromStatement.__doc__]
IdentityMap
InspectionAttr A base class applied to all ORM objects that can be returned [extrait de InspectionAttr.__doc__]
InspectionAttrInfo Adds the ``.info`` attribute to :class:`.InspectionAttr`. [extrait de InspectionAttrInfo.__doc__]
InstanceEvents Define events specific to object lifecycle. [extrait de InstanceEvents.__doc__]
InstanceState tracks state information at the instance level. [extrait de InstanceState.__doc__]
InstrumentationEvents Events related to class instrumentation events. [extrait de InstrumentationEvents.__doc__]
InstrumentedAttribute Class bound instrumented attribute which adds basic [extrait de InstrumentedAttribute.__doc__]
Load Represents loader options which modify the state of a [extrait de Load.__doc__]
LoaderCriteriaOption Add additional WHERE criteria to the load for all occurrences of [extrait de LoaderCriteriaOption.__doc__]
Mapped Represent an ORM mapped :term:`descriptor` attribute for typing purposes. [extrait de Mapped.__doc__]
Mapper Define the correlation of class attributes to database table [extrait de Mapper.__doc__]
MapperEvents Define events specific to mappings. [extrait de MapperEvents.__doc__]
MapperProperty Represent a particular class attribute mapped by :class:`_orm.Mapper`. [extrait de MapperProperty.__doc__]
ORMExecuteState Represents a call to the :meth:`_orm.Session.execute` method, as passed [extrait de ORMExecuteState.__doc__]
PropComparator Defines SQL operators for :class:`.MapperProperty` objects. [extrait de PropComparator.__doc__]
Query ORM-level SQL construction object. [extrait de Query.__doc__]
QueryableAttribute Base class for :term:`descriptor` objects that intercept [extrait de QueryableAttribute.__doc__]
QueryContext
QueryEvents Represent events within the construction of a :class:`_query.Query` [extrait de QueryEvents.__doc__]
registry Generalized registry for mapping classes. [extrait de registry.__doc__]
RelationshipProperty Describes an object property that holds a single item or list [extrait de RelationshipProperty.__doc__]
scoped_session Provides scoped management of :class:`.Session` objects. [extrait de scoped_session.__doc__]
Session Manages persistence operations for ORM-mapped objects. [extrait de Session.__doc__]
SessionEvents Define events specific to :class:`.Session` lifecycle. [extrait de SessionEvents.__doc__]
sessionmaker A configurable :class:`.Session` factory. [extrait de sessionmaker.__doc__]
SessionTransaction A :class:`.Session`-level transaction. [extrait de SessionTransaction.__doc__]
SynonymProperty
UOWTransaction
UserDefinedOption Base class for a user-defined option that can be consumed from the [extrait de UserDefinedOption.__doc__]

Liste des fonctions du module sqlalchemy.orm

Signature de la fonction Description
aliased(element, alias=None, name=None, flat=False, adapt_on_names=False) Produce an alias of the given element, usually an :class:`.AliasedClass` [extrait de aliased.__doc__]
as_declarative(**kw)
backref(name, **kwargs) Create a back reference with explicit keyword arguments, which are the [extrait de backref.__doc__]
class_mapper(class_, configure=True) Given a class, return the primary :class:`_orm.Mapper` associated [extrait de class_mapper.__doc__]
clear_mappers() Remove all mappers from all classes. [extrait de clear_mappers.__doc__]
close_all_sessions() Close all sessions in memory. [extrait de close_all_sessions.__doc__]
column_property(*columns, **kwargs) Provide a column-level property for use with a mapping. [extrait de column_property.__doc__]
composite(class_, *attrs, **kwargs) Return a composite column-based property for use with a Mapper. [extrait de composite.__doc__]
configure_mappers() Initialize the inter-mapper relationships of all mappers that [extrait de configure_mappers.__doc__]
contains_alias(alias) Return a :class:`.MapperOption` that will indicate to the [extrait de contains_alias.__doc__]
contains_eager(*keys, **kw) Indicate that the given attribute should be eagerly loaded from [extrait de contains_eager.__doc__]
create_session(bind=None, **kwargs) Create a new :class:`.Session` [extrait de create_session.__doc__]
declarative_base(bind=None, metadata=None, mapper=None, cls=<class 'object'>, name='Base', constructor=<function _declarative_constructor at 0x7f40cb7f5090>, class_registry=None, metaclass=<class 'sqlalchemy.orm.decl_api.DeclarativeMeta'>) Construct a base class for declarative class definitions. [extrait de declarative_base.__doc__]
declarative_mixin(cls) Mark a class as providing the feature of "declarative mixin". [extrait de declarative_mixin.__doc__]
defaultload(*keys) Indicate an attribute should load using its default loader style. [extrait de defaultload.__doc__]
defer(key, *addl_attrs, **kw) Indicate that the given column-oriented attribute should be deferred, [extrait de defer.__doc__]
deferred(*columns, **kw) Indicate a column-based mapped attribute that by default will [extrait de deferred.__doc__]
dynamic_loader(argument, **kw) Construct a dynamically-loading mapper property. [extrait de dynamic_loader.__doc__]
eagerload(*args, **kwargs) A synonym for :func:`joinedload()`. [extrait de eagerload.__doc__]
foreign(expr) Annotate a portion of a primaryjoin expression [extrait de foreign.__doc__]
has_inherited_table(cls) Given a class, return True if any of the classes it inherits from has a [extrait de has_inherited_table.__doc__]
immediateload(*keys) Indicate that the given attribute should be loaded using [extrait de immediateload.__doc__]
join(left, right, onclause=None, isouter=False, full=False, join_to_left=None) Produce an inner join between left and right clauses. [extrait de join.__doc__]
joinedload(*keys, **kw) Indicate that the given attribute should be loaded using joined [extrait de joinedload.__doc__]
lazyload(*keys) Indicate that the given attribute should be loaded using "lazy" [extrait de lazyload.__doc__]
load_only(*attrs) Indicate that for a particular entity, only the given list [extrait de load_only.__doc__]
make_transient(instance) Alter the state of the given instance so that it is :term:`transient`. [extrait de make_transient.__doc__]
make_transient_to_detached(instance) Make the given transient instance :term:`detached`. [extrait de make_transient_to_detached.__doc__]
mapper(class_, local_table=None, properties=None, primary_key=None, non_primary=False, inherits=None, inherit_condition=None, inherit_foreign_keys=None, always_refresh=False, version_id_col=None, version_id_generator=None, polymorphic_on=None, _polymorphic_map=None, polymorphic_identity=None, concrete=False, with_polymorphic=None, polymorphic_load=None, allow_partial_pks=True, batch=True, column_prefix=None, include_properties=None, exclude_properties=None, passive_updates=True, passive_deletes=False, confirm_deleted_rows=True, eager_defaults=False, legacy_is_orphan=False, _compiled_cache_size=100) Direct constructor for a new :class:`_orm.Mapper` object. [extrait de mapper.__doc__]
merge_frozen_result(session, statement, frozen_result, load=True) Merge a :class:`_engine.FrozenResult` back into a :class:`_orm.Session`, [extrait de merge_frozen_result.__doc__]
merge_result(query, iterator, load=True) Merge a result into this :class:`.Query` object's Session. [extrait de merge_result.__doc__]
noload(*keys) Indicate that the given relationship attribute should remain unloaded. [extrait de noload.__doc__]
object_mapper(instance) Given an object, return the primary Mapper associated with the object [extrait de object_mapper.__doc__]
object_session(instance) Return the :class:`.Session` to which the given instance belongs. [extrait de object_session.__doc__]
outerjoin(left, right, onclause=None, full=False, join_to_left=None) Produce a left outer join between left and right clauses. [extrait de outerjoin.__doc__]
polymorphic_union(table_map, typecolname, aliasname='p_union', cast_nulls=True) Create a ``UNION`` statement used by a polymorphic mapper. [extrait de polymorphic_union.__doc__]
public_factory(target, location, class_location=None) Produce a wrapping function for the given cls or classmethod. [extrait de public_factory.__doc__]
query_expression(default_expr=<sqlalchemy.sql.elements.Null object at 0x7f40cbdd7a30>) Indicate an attribute that populates from a query-time SQL expression. [extrait de query_expression.__doc__]
raiseload(*keys, **kw) Indicate that the given attribute should raise an error if accessed. [extrait de raiseload.__doc__]
reconstructor(fn) Decorate a method as the 'reconstructor' hook. [extrait de reconstructor.__doc__]
relation(*arg, **kw) A synonym for :func:`relationship`. [extrait de relation.__doc__]
relationship(argument, secondary=None, primaryjoin=None, secondaryjoin=None, foreign_keys=None, uselist=None, order_by=False, backref=None, back_populates=None, overlaps=None, post_update=False, cascade=False, viewonly=False, lazy='select', collection_class=None, passive_deletes=False, passive_updates=True, remote_side=None, enable_typechecks=True, join_depth=None, comparator_factory=None, single_parent=False, innerjoin=False, distinct_target_key=None, doc=None, active_history=False, cascade_backrefs=True, load_on_pending=False, bake_queries=True, _local_remote_pairs=None, query_class=None, info=None, omit_join=None, sync_backref=None, _legacy_inactive_history_style=False) Provide a relationship between two mapped classes. [extrait de relationship.__doc__]
remote(expr) Annotate a portion of a primaryjoin expression [extrait de remote.__doc__]
selectin_polymorphic(base_cls, classes) Indicate an eager load should take place for all attributes [extrait de selectin_polymorphic.__doc__]
selectinload(*keys) Indicate that the given attribute should be loaded using [extrait de selectinload.__doc__]
subqueryload(*keys) Indicate that the given attribute should be loaded using [extrait de subqueryload.__doc__]
synonym(name, map_column=None, descriptor=None, comparator_factory=None, doc=None, info=None) Denote an attribute name as a synonym to a mapped property, [extrait de synonym.__doc__]
synonym_for(name, map_column=False) Decorator that produces an :func:`_orm.synonym` [extrait de synonym_for.__doc__]
undefer(key, *addl_attrs) Indicate that the given column-oriented attribute should be undeferred, [extrait de undefer.__doc__]
undefer_group(name) Indicate that columns within the given deferred group name should be [extrait de undefer_group.__doc__]
validates(*names, **kw) Decorate a method as a 'validator' for one or more named properties. [extrait de validates.__doc__]
was_deleted(object_) Return True if the given object was deleted [extrait de was_deleted.__doc__]
with_expression(key, expression) Apply an ad-hoc SQL expression to a "deferred expression" attribute. [extrait de with_expression.__doc__]
with_parent(instance, prop, from_entity=None) Create filtering criterion that relates this query's primary entity [extrait de with_parent.__doc__]
with_polymorphic(base, classes, selectable=False, flat=False, polymorphic_on=None, aliased=False, innerjoin=False, _use_mapper_path=False, _existing_alias=None) Produce an :class:`.AliasedClass` construct which specifies [extrait de with_polymorphic.__doc__]

Liste des variables globales du module sqlalchemy.orm

Nom de la variable globale Valeur
EXT_CONTINUE symbol('EXT_CONTINUE')
EXT_SKIP symbol('EXT_SKIP')
EXT_STOP symbol('EXT_STOP')
MANYTOMANY symbol('MANYTOMANY')
MANYTOONE symbol('MANYTOONE')
NOT_EXTENSION symbol('NOT_EXTENSION')
ONETOMANY symbol('ONETOMANY')

Liste des alias du module sqlalchemy.orm

Nom de l'alias Définition ciblée
with_loader_criteria orm