]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commit
Documentation updates for 1.4
authorMike Bayer <mike_mp@zzzcomputing.com>
Sun, 28 Jun 2020 15:59:34 +0000 (11:59 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Thu, 6 Aug 2020 02:19:46 +0000 (22:19 -0400)
commit30885744142d89740d459f4dae670ba4775d1d8c
tree0fdd30c0c96778029a48414195f95c5b1fdba30c
parentc7b489b25802f7a25ef78d0731411295c611cc1c
Documentation updates for 1.4

* major additions to 1.4 migration doc; removed additional
  verbosity regarding caching methodology and reorganized the
  doc to present itself more as a "what's changed" guide

* as we now have a path for asyncio, update that doc so that
  we aren't spreading obsolete information

* updates to the 2.0 migration guide with latest info, however
  this is still an architecture doc and not a migration guide
  yet, will need further rework.

* start really talking about 1.x vs. 2.0 style everywhere.  Querying
  is most of the docs so this is going to be a prominent
  theme, start getting it to fit in

* Add introductory documentation for ORM example sections as these
  are too sparse

* new documentation for do_orm_execute(), many separate sections,
  adding deprecation notes to before_compile() and similar

* new example suites to illustrate do_orm_execute(),
  with_loader_criteria()

* modernized horizontal sharding examples and added a separate
  example to distinguish between multiple databases and single
  database w/ multiple tables use case

* introducing DEEP ALCHEMY, will use zzzeeksphinx 1.1.6

* no name for the alchemist yet however the dragon's name
  is FlambĂ©

Change-Id: Id6b5c03b1ce9ddb7b280f66792212a0ef0a1c541
35 files changed:
doc/build/changelog/migration_14.rst
doc/build/changelog/migration_20.rst
doc/build/changelog/unreleased_14/4472.rst
doc/build/conf.py
doc/build/core/connections.rst
doc/build/glossary.rst
doc/build/index.rst
doc/build/orm/events.rst
doc/build/orm/examples.rst
doc/build/orm/extending.rst
doc/build/orm/extensions/baked.rst
doc/build/orm/internals.rst
doc/build/orm/mapped_attributes.rst
doc/build/orm/query.rst
doc/build/orm/session_api.rst
doc/build/orm/session_basics.rst
doc/build/orm/session_events.rst
doc/build/orm/session_transaction.rst
doc/build/orm/tutorial.rst
examples/dogpile_caching/__init__.py
examples/extending_query/__init__.py [new file with mode: 0644]
examples/extending_query/filter_public.py [new file with mode: 0644]
examples/extending_query/temporal_range.py [new file with mode: 0644]
examples/sharding/__init__.py
examples/sharding/separate_databases.py [moved from examples/sharding/attribute_shard.py with 79% similarity]
examples/sharding/separate_tables.py [new file with mode: 0644]
lib/sqlalchemy/engine/interfaces.py
lib/sqlalchemy/engine/result.py
lib/sqlalchemy/event/api.py
lib/sqlalchemy/event/legacy.py
lib/sqlalchemy/orm/__init__.py
lib/sqlalchemy/orm/events.py
lib/sqlalchemy/orm/loading.py
lib/sqlalchemy/orm/session.py
test/base/test_utils.py