Commit Graph

23 Commits

Author SHA1 Message Date
Mike Bayer 0bd632804e - fix links for loading, add a redirect page
bump

foo
2014-12-27 19:52:44 -05:00
Mike Bayer 9561321d03 - squash-merge the improve_toc branch, which moves all the Sphinx styling
and extensions into an external library, and also reorganizes most large documentation
pages into many small areas to reduce scrolling and better present the context
into a more fine-grained hierarchy.
2014-12-17 17:24:23 -05:00
Mike Bayer 8200c2cd35 - edits to the subqueryload ordering merge 2014-11-05 15:11:13 -05:00
Jack Zhou 9e621d18aa Added documentation about interaction between subqueryload and LIMIT/OFFSET. 2014-08-07 12:08:43 -07:00
Alex Gaynor 1caa7fafbd Fix many typos throughout the codebase
Found using: https://github.com/intgr/topy
2014-04-26 13:13:13 -07:00
Mike Bayer 1921e7a3cb - extensive cross-linking of relationship options with their documentation sections
- convert all paramter references in relationship documentation to :paramref:
2014-02-16 14:28:56 -05:00
Mike Bayer 0b88d01127 no such thing as default_strategy()... 2013-10-28 13:54:08 -04:00
Mike Bayer 8ab39fb652 - whitespace below ..version, sigh 2013-10-28 13:48:44 -04:00
Mike Bayer 1b25ed907f - merge ticket_1418 branch, [ticket:1418]
- The system of loader options has been entirely rearchitected to build
upon a much more comprehensive base, the :class:`.Load` object.  This
base allows any common loader option like :func:`.joinedload`,
:func:`.defer`, etc. to be used in a "chained" style for the purpose
of specifying options down a path, such as ``joinedload("foo").subqueryload("bar")``.
The new system supersedes the usage of dot-separated path names,
multiple attributes within options, and the usage of ``_all()`` options.
-  Added a new load option :func:`.orm.load_only`.  This allows a series
of column names to be specified as loading "only" those attributes,
deferring the rest.
2013-10-06 20:29:08 -04:00
Mike Bayer be4b854304 - more docs
- it appears we can get rid of all those "XYZ_toplevel" names and use :doc:.
2012-10-26 20:59:21 -04:00
Mike Bayer d8d080a769 Add some Sphinx related version informations paragraph-level markups,
such as ``.. versionaddedd::``, ``.. versionchanged::`` and ``.. deprecated::``.
2012-06-08 15:56:58 -04:00
Mike Bayer 82b90175f7 - [feature] Added new capability to relationship
loader options to allow "default" loader strategies.
Pass '*' to any of joinedload(), lazyload(),
subqueryload(), or noload() and that becomes the
loader strategy used for all relationships,
except for those explicitly stated in the
Query.  Thanks to up-and-coming contributor
Kent Bower for an exhaustive and well
written test suite !  [ticket:2351]
2012-01-22 20:11:03 -05:00
Mike Bayer 06e65c2d4e marathon doc updating session including a rewrite of unicode paragraphs 2011-12-04 23:08:35 -05:00
Mike Bayer 74fe7b60b7 - doc updates in loading
- de-emphasize contains_alias() which is pretty much a non-use case
- add docs for immediateload which have been missing all this time
- fix links, formatting
2011-11-24 10:47:10 -05:00
Mike Bayer a3705cd17b - document query.get(), ObjectDeletedError fully, [ticket:2146] 2011-07-23 12:27:09 -04:00
Mike Bayer 06e84d5bcc fix some more typos 2011-07-20 19:42:06 -04:00
Mike Bayer a7a895efd4 put a really explicit note about joinedload vs. join, everywhere joinedload() is mentioned 2011-07-20 19:32:30 -04:00
Mike Bayer 85084caeff - A single contains_eager() call across
multiple entities will indicate all collections
along that path should load, instead of requiring
distinct contains_eager() calls for each endpoint
(which was never correctly documented).
[ticket:2032]

- The "name" field used in orm.aliased() now renders
in the resulting SQL statement.
2011-02-05 16:09:49 -05:00
Mike Bayer 49ede80b05 doc updates 2011-01-03 13:55:27 -05:00
Mike Bayer 18eef3a22b finish an unfinished sentence 2011-01-02 20:41:30 -05:00
Mike Bayer 350aed3fdb - whitespace removal bonanza 2011-01-02 14:23:42 -05:00
Mike Bayer b42cbed427 almost through. 2010-09-04 19:59:21 -04:00
Mike Bayer a315c5d431 continued... 2010-09-04 16:00:25 -04:00