Skip to content

Commit 0e0cf68

Browse files
zzzeekGerrit Code Review
zzzeek
authored and
Gerrit Code Review
committed
Merge "rework ORM mapping docs" into main
2 parents a453256 + f9f1e8b commit 0e0cf68

21 files changed

Lines changed: 1065 additions & 549 deletions

‎doc/build/changelog/migration_13.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Relationship to AliasedClass replaces the need for non primary mappers
8585
-----------------------------------------------------------------------
8686

8787
The "non primary mapper" is a :class:`_orm.Mapper` created in the
88-
:ref:`classical_mapping` style, which acts as an additional mapper against an
88+
:ref:`orm_imperative_mapping` style, which acts as an additional mapper against an
8989
already mapped class against a different kind of selectable. The non primary
9090
mapper has its roots in the 0.1, 0.2 series of SQLAlchemy where it was
9191
anticipated that the :class:`_orm.Mapper` object was to be the primary query

‎doc/build/changelog/migration_14.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ the :class:`_orm.registry` object, and fall into these categories:
288288
* Declarative Table
289289
* Imperative Table (Hybrid)
290290
* :ref:`orm_declarative_dataclasses`
291-
* :ref:`Imperative (a.k.a. "classical" mapping) <classical_mapping>`
291+
* :ref:`Imperative (a.k.a. "classical" mapping) <orm_imperative_mapping>`
292292
* Using :meth:`_orm.registry.map_imperatively`
293293
* :ref:`orm_imperative_dataclasses`
294294

‎doc/build/core/inspection.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,18 @@ Below is a listing of many of the most common inspection targets.
2525
to per attribute state via the :class:`.AttributeState` interface as well
2626
as the per-flush "history" of any attribute via the :class:`.History`
2727
object.
28+
29+
.. seealso::
30+
31+
:ref:`orm_mapper_inspection_instancestate`
32+
2833
* ``type`` (i.e. a class) - a class given will be checked by the ORM for a
2934
mapping - if so, a :class:`_orm.Mapper` for that class is returned.
35+
36+
.. seealso::
37+
38+
:ref:`orm_mapper_inspection_mapper`
39+
3040
* mapped attribute - passing a mapped attribute to :func:`_sa.inspect`, such
3141
as ``inspect(MyClass.some_attribute)``, returns a :class:`.QueryableAttribute`
3242
object, which is the :term:`descriptor` associated with a mapped class.
@@ -36,3 +46,4 @@ Below is a listing of many of the most common inspection targets.
3646
attribute.
3747
* :class:`.AliasedClass` - returns an :class:`.AliasedInsp` object.
3848

49+

‎doc/build/dialects/oracle.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,15 @@ construction arguments, are as follows:
5050
.. autoclass:: RAW
5151
:members: __init__
5252

53+
.. _cx_oracle:
5354

5455
cx_Oracle
5556
---------
5657

5758
.. automodule:: sqlalchemy.dialects.oracle.cx_oracle
5859

60+
.. _oracledb:
61+
5962
python-oracledb
6063
---------------
6164

‎doc/build/glossary.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ Glossary
2525

2626
:ref:`migration_20_toplevel`
2727

28+
reflection
29+
reflected
30+
In SQLAlchemy, this term refers to the feature of querying a database's
31+
schema catalogs in order to load information about existing tables,
32+
columns, constraints, and other constructs. SQLAlchemy includes
33+
features that can both provide raw data for this information, as well
34+
as that it can construct Core/ORM usable :class:`.Table` objects
35+
from database schema catalogs automatically.
36+
37+
.. seealso::
38+
39+
:ref:`metadata_reflection_toplevel` - complete background on
40+
database reflection.
41+
2842

2943
imperative
3044
declarative

‎doc/build/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ SQLAlchemy Documentation
7070
**SQLAlchemy ORM**
7171

7272
* **ORM Configuration:**
73-
:doc:`Mapper Configuration <orm/mapper_config>` |
73+
:doc:`Mapped Class Configuration <orm/mapper_config>` |
7474
:doc:`Relationship Configuration <orm/relationships>`
7575

7676
* **ORM Usage:**

‎doc/build/orm/classical.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:orphan:
22

3-
Moved! :ref:`classical_mapping`
3+
Moved! :ref:`orm_imperative_mapping`
44

55

0 commit comments

Comments
 (0)