Commit Graph

34 Commits

Author SHA1 Message Date
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 0c19c1c66f - reorganize docs so expression, schema are broken out into subfiles, they're too big
- fix the targeting of module names moved around by using custom handlers for "Bases", etc.
2013-08-18 18:01:27 -04:00
Mike Bayer 8a1dfd5c1d add in inherited methods to many of these 2012-10-30 16:20:45 -04:00
Mike Bayer 477dd0f774 this is already in an automodule... 2012-08-22 14:23:13 -04:00
Mike Bayer 0e9ad80760 - [feature] Enhanced GenericFunction and func.*
to allow for user-defined GenericFunction
    subclasses to be available via the func.*
    namespace automatically by classname,
    optionally using a package name as well.
2012-08-22 13:54:13 -04:00
Mike Bayer 099c9d39eb - expand out all the methods on insert/update/delete/select for now
- remove deprecation test
2012-08-19 22:04:33 -04:00
Mike Bayer 223af5b116 - [feature] The prefix_with() method is now available
on each of select(), insert(), update(), delete(),
    all with the same API, accepting multiple
    prefix calls, as well as a "dialect name" so that
    the prefix can be limited to one kind of dialect.
    [ticket:2431]
2012-08-19 21:15:40 -04:00
Mike Bayer b47c185fc4 tighten this up 2012-08-18 10:41:17 -04:00
Mike Bayer a180239d8e docs for custom ops... 2012-08-16 12:36:13 -04:00
Mike Bayer d212f7e554 merge tip. 2012-08-13 17:54:47 -04:00
Mike Bayer 51417b942f docs 2012-08-13 17:53:35 -04:00
Mike Bayer 8c7914e181 - update engine docstrings due to move
- struggle with Operators class autodoc
2012-08-13 17:35:27 -04:00
Mike Bayer e8ff3047c6 a lot of docs 2012-07-18 19:08:31 -04:00
Mike Bayer de115ae406 - a big renaming of all the _Underscore classes to have
plain names.  The old names are still defined for
backwards compatibility.
- _BindParamClause renamed to BindParameter
2012-07-17 20:04:22 -04:00
Mike Bayer 4d2c1e2f17 - [feature] Added support for MSSQL INSERT,
UPDATE, and DELETE table hints, using
new with_hint() method on UpdateBase.
[ticket:2430]
2012-03-13 14:00:05 -07:00
Mike Bayer 1607b74f85 - [feature] Added cte() method to Query,
invokes common table expression support
from the Core (see below). [ticket:1859]

- [feature] Added support for SQL standard
common table expressions (CTE), allowing
SELECT objects as the CTE source (DML
not yet supported).  This is invoked via
the cte() method on any select() construct.
[ticket:1859]
2012-03-03 13:00:44 -05:00
Mike Bayer 72d10093f4 document autocommit when using the compiler extension, update the "understanding autocommit" section 2011-08-18 13:02:30 -04:00
Mike Bayer 73a4ca0286 - move Operators and ColumnOperators into sqlalchemy.sql.operators - since this
is strictly a system of routing Python operators into functions.  Keep the
references available in expression.py for the near future.
2011-05-28 20:24:57 -04:00
Mike Bayer ba299476b8 - get all comparison operators to document with sphinx - column based, relationship based.
Should fix misunderstandings like [ticket:2177]
2011-05-26 13:30:26 -04:00
Mike Bayer 74a6cb17c8 - add some docs to hybrid comparators, operators/comparator logic at the base 2011-05-22 15:54:17 -04:00
Mike Bayer 69dcd805d2 - Added explicit true()/false() constructs to expression
lib - coercion rules will intercept "False"/"True"
into these constructs.  In 0.6, the constructs were
typically converted straight to string, which was
no longer accepted in 0.7.  [ticket:2117]
2011-04-17 15:37:12 -04:00
Mike Bayer 4f6f0edd78 a crapload of doc tweaks including [ticket:1666], thanks Toby ! 2011-04-16 12:04:54 -04:00
Mike Bayer 50764fd641 - add attrstrings for all the important mapper() attrbutes, [ticket:2094].
Sticking with quotes here since that's what's used everywhere else.
- rename "API Documentation - XYZ" to "XYZ API".
- move connection API docs to the bottom of that section.  still
floating between separate API sections vs. inline API sections, not
sure how to be consistent.
- fix outdated paragraph about derived_attrbutes
- other target function fixes
2011-03-20 14:00:16 -04:00
Mike Bayer 2136054ca8 - some doc reorg
- change engine.Connection to _connection_cls so sphinx doesn't get upset
- globally add "." to all :class:`Foo`
- start naming sections that are mostly docstrings "API Documentation - blah blah"
- move some ad-hoc docstrings into "API" sections, there is some inconsistency here
and it may be that we just have to leave it that way
- add "internals" rsts to core, orm, I'm not super thrilled how these look but they are
targeted by some of the public api docs, users typically become aware of these anyway
2011-03-17 21:13:14 -04:00
Mike Bayer 020d6ef8f0 - Added over() function, method to FunctionElement
classes, produces the _Over() construct which
in turn generates "window functions", i.e.
"<window function> OVER (PARTITION BY <partition by>,
ORDER BY <order by>)".
[ticket:1844]
2011-02-10 21:57:44 -05:00
Mike Bayer 3f9a343d72 - Query.distinct() now accepts column expressions
as *args, interpreted by the Postgresql dialect
  as DISTINCT ON (<expr>). [ticket:1069]
- select.distinct() now accepts column expressions
  as *args, interpreted by the Postgresql dialect
  as DISTINCT ON (<expr>).  Note this was already
  available via passing a list to the `distinct`
  keyword argument to select(). [ticket:1069]
- select.prefix_with() accepts multiple expressions
  (i.e. *expr), 'prefix' keyword argument to select()
  accepts a list or tuple.
- Passing a string to the `distinct` keyword argument
  of `select()` for the purpose of emitting special
  MySQL keywords (DISTINCTROW etc.) is deprecated -
  use `prefix_with()` for this.
- put kw arguments to select() in order
- restore docs for _SelectBase, renamed from _SelectBaseMixin
2011-02-10 14:17:08 -05:00
Mike Bayer e80eac22a8 - figured out the ::autodata directive, can move the docstring for
expression.func into the .py module
- added a note about logging only being checked on new connections,
as one user had this issue awhile back, and I suspect it for
a current ML user issue
2011-02-09 16:30:49 -05:00
Mike Bayer dff5a404e4 - getting slightly more consistent behavior for the edge case of pk columns
with server default - autoincrement is now false with any server_default,
so these all return None, applies consistency to [ticket:2020], [ticket:2021].
if prefetch is desired a "default" should be used instead of server_default.
2011-01-15 16:42:29 -05:00
Mike Bayer 350aed3fdb - whitespace removal bonanza 2011-01-02 14:23:42 -05:00
Mike Bayer 79c25ede44 - Added type_coerce(expr, type_) expression element.
Treats the given expression as the given type when evaluating
expressions and processing result rows, but does not
affect the generation of SQL, other than an anonymous label.
2010-10-23 16:40:39 -04:00
Mike Bayer 30e4b186f2 doc edits 2010-09-22 23:48:17 -04:00
Mike Bayer 914ae5bcd4 fixup 2010-09-05 16:06:39 -04:00
Mike Bayer 1f65ac6679 roughly the finished product. 2010-09-04 21:02:35 -04:00
Mike Bayer 4e24d6cb01 experiment with removing the API section and putting docstrings inline.
new outline section is provided with a new flow.
2010-09-04 13:25:13 -04:00