summaryrefslogtreecommitdiff
path: root/examples/extending_query/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'examples/extending_query/__init__.py')
-rw-r--r--examples/extending_query/__init__.py17
1 files changed, 17 insertions, 0 deletions
diff --git a/examples/extending_query/__init__.py b/examples/extending_query/__init__.py
new file mode 100644
index 000000000..b939c268c
--- /dev/null
+++ b/examples/extending_query/__init__.py
@@ -0,0 +1,17 @@
+"""
+Recipes which illustrate augmentation of ORM SELECT behavior as used by
+:meth:`_orm.Session.execute` with :term:`2.0 style` use of
+:func:`_sql.select`, as well as the :term:`1.x style` :class:`_orm.Query`
+object.
+
+Examples include demonstrations of the :func:`_orm.with_loader_criteria`
+option as well as the :meth:`_orm.SessionEvents.do_orm_execute` hook.
+
+As of SQLAlchemy 1.4, the :class:`_orm.Query` construct is unified
+with the :class:`_expression.Select` construct, so that these two objects
+are mostly the same.
+
+
+.. autosource::
+
+""" # noqa