File: internals.rst

package info (click to toggle)
sqlalchemy 1.4.46%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 22,444 kB
  • sloc: python: 341,434; ansic: 1,760; makefile: 226; xml: 17; sh: 7
file content (118 lines) | stat: -rw-r--r-- 2,317 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
.. _orm_internal_toplevel:

ORM Internals
=============

Key ORM constructs, not otherwise covered in other
sections, are listed here.

.. currentmodule:: sqlalchemy.orm

.. autoclass:: AttributeState
    :members:

.. autoclass:: CascadeOptions
    :members:

.. autoclass:: ClassManager
    :members:

.. autoclass:: ColumnProperty
    :members:

    .. attribute:: Comparator.expressions

         The full sequence of columns referenced by this
         attribute, adjusted for any aliasing in progress.

         .. versionadded:: 1.3.17

         .. seealso::

            :ref:`maptojoin` - usage example

.. autoclass:: CompositeProperty
    :members:


.. autoclass:: AttributeEvent
    :members:

.. autoclass:: IdentityMap
    :members:

.. autoclass:: InspectionAttr
    :members:

.. autoclass:: InspectionAttrInfo
    :members:

.. autoclass:: InstanceState
    :members:


.. autoclass:: InstrumentedAttribute
    :members: __get__, __set__, __delete__
    :undoc-members:

.. autodata:: MANYTOONE

.. autodata:: MANYTOMANY

.. autoclass:: Mapped

.. autoclass:: MapperProperty
    :members:

    .. py:attribute:: info

        Info dictionary associated with the object, allowing user-defined
        data to be associated with this :class:`.InspectionAttr`.

        The dictionary is generated when first accessed.  Alternatively,
        it can be specified as a constructor argument to the
        :func:`.column_property`, :func:`_orm.relationship`, or :func:`.composite`
        functions.

        .. versionchanged:: 1.0.0 :attr:`.InspectionAttr.info` moved
           from :class:`.MapperProperty` so that it can apply to a wider
           variety of ORM and extension constructs.

        .. seealso::

            :attr:`.QueryableAttribute.info`

            :attr:`.SchemaItem.info`

.. autodata:: NOT_EXTENSION

.. autofunction:: merge_result

.. autofunction:: merge_frozen_result


.. autodata:: ONETOMANY

.. autoclass:: PropComparator
    :members:
    :inherited-members:

.. autoclass:: RelationshipProperty
    :members:
    :inherited-members:

.. autoclass:: SynonymProperty
    :members:
    :inherited-members:

.. autoclass:: QueryContext
    :members:


.. autoclass:: QueryableAttribute
    :members:
    :inherited-members:

.. autoclass:: UOWTransaction
    :members: