summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2021-02-26 15:28:30 +0000
committerGerrit Code Review <gerrit@ci3.zzzcomputing.com>2021-02-26 15:28:30 +0000
commitc660f496a9611aca81606eaa73449cd069b88455 (patch)
treeb9cf9eced4e6a42903fc4c165d16bb72f18cc0dd /lib
parenta8678d660af78a93e08585540e7a23e0b4229ff1 (diff)
parent638ec10920268b0332c1bf1bb2bf1181979b3f9c (diff)
downloadsqlalchemy-c660f496a9611aca81606eaa73449cd069b88455.tar.gz
Merge "document declarative base made non-dynamically"
Diffstat (limited to 'lib')
-rw-r--r--lib/sqlalchemy/orm/__init__.py1
-rw-r--r--lib/sqlalchemy/orm/decl_api.py14
2 files changed, 14 insertions, 1 deletions
diff --git a/lib/sqlalchemy/orm/__init__.py b/lib/sqlalchemy/orm/__init__.py
index 4793fc638..ac06efba6 100644
--- a/lib/sqlalchemy/orm/__init__.py
+++ b/lib/sqlalchemy/orm/__init__.py
@@ -22,6 +22,7 @@ from .attributes import QueryableAttribute # noqa
from .context import QueryContext # noqa
from .decl_api import as_declarative # noqa
from .decl_api import declarative_base # noqa
+from .decl_api import DeclarativeMeta # noqa
from .decl_api import declared_attr # noqa
from .decl_api import has_inherited_table # noqa
from .decl_api import registry # noqa
diff --git a/lib/sqlalchemy/orm/decl_api.py b/lib/sqlalchemy/orm/decl_api.py
index 8afdb3a50..1166d307e 100644
--- a/lib/sqlalchemy/orm/decl_api.py
+++ b/lib/sqlalchemy/orm/decl_api.py
@@ -657,11 +657,23 @@ class registry(object):
__tablename__ = "my_table"
id = Column(Integer, primary_key=True)
+ The above dynamically generated class is equivalent to the
+ non-dynamic example below::
+
+ from sqlalchemy.orm import registry
+ from sqlalchemy.orm.decl_api import DeclarativeMeta
+
+ mapper_registry = registry()
+
+ class Base(metaclass=DeclarativeMeta):
+ __abstract__ = True
+ registry = mapper_registry
+ metadata = mapper_registry.metadata
+
The :meth:`_orm.registry.generate_base` method provides the
implementation for the :func:`_orm.declarative_base` function, which
creates the :class:`_orm.registry` and base class all at once.
-
See the section :ref:`orm_declarative_mapping` for background and
examples.