Commit Graph

2307 Commits

Author SHA1 Message Date
Mike Bayer 95e9998c41 merge whatever 2010-09-05 17:26:38 -04:00
Mike Bayer be5207a98f not sure why chrisw changed this but would like to have the copyright link 2010-09-05 17:23:23 -04:00
Mike Bayer e145b44620 dont need this 2010-09-05 16:11:08 -04:00
Mike Bayer 914ae5bcd4 fixup 2010-09-05 16:06:39 -04:00
Mike Bayer 703ce7f179 - rewrote the "connections" section
- improved pool docs
- typos etc.
- ClauseElement.execute() and scalar() make no sense - these are depreacted.
The official home is Executable.
- alias() is not executable, allowing it is sloppy so this goes under
the deprecated umbrella
2010-09-05 14:44:58 -04:00
Mike Bayer 1f65ac6679 roughly the finished product. 2010-09-04 21:02:35 -04: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
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
Mike Bayer b6fe3a83e9 restore the deprecated docs 2010-09-04 10:25:58 -04:00
Mike Bayer 33b70a1f02 merge from tip 2010-09-03 17:57:20 -04:00
Mike Bayer 3d439e1801 - a large hill to climb. Added declarative examples to all the
"basic relationship" examples, cleaned up the examples and added
some more explicitness.  Also renamed "treenodes" to "nodes" and
added self-referential declarative example.
- Added info/examples on how to join tables directly when querying with
joined table inheritance.
-  Starting to talk about hybrids in the main mapper docs some more.
introducoed the idea that synonyms are on their way out.
- SQL expressions as mapped attributes also gets better verbiage,
alternative approaches to them, including hybrids.
- modernized the hybrid example.
- object_session() as a standalone function wasn't documented ?!
2010-08-30 20:10:03 -04:00
Mike Bayer abbb080d45 some doc updates 2010-08-24 01:01:04 -04:00
Mike Bayer dc31eb352a merge tip 2010-08-14 20:52:57 -04:00
Mike Bayer 8fc50cd3a4 - Another pass through the series of error messages
emitted when relationship() is configured with
ambiguous arguments.   The "foreign_keys"
setting is no longer mentioned, as it is almost
never needed and it is preferable users set up
correct ForeignKey metadata, which is now the
recommendation.  If 'foreign_keys'
is used and is incorrect, the message suggests
the attribute is probably unnecessary.  Docs
for the attribute are beefed up.  This
because all confused relationship() users on the
ML appear to be attempting to use foreign_keys
due to the message, which only confuses them
further since Table metadata is much clearer.

- If the "secondary" table has no ForeignKey metadata
and no foreign_keys is set, even though the
user is passing screwed up information, it is assumed
that primary/secondaryjoin expressions should
consider only and all cols in "secondary" to be
foreign.  It's not possible with "secondary" for
the foreign keys to be elsewhere in any case.
A warning is now emitted instead of an error,
and the mapping succeeds. [ticket:1877]

- fixed incorrect "Alternate Collection Mappings" reference
in the docs, not sure if someone wants to reference
"Rows that Point to Themselves" function
- "Collection Mapping" is "Advanced Collection Mapping", this
section is troublesome since nobody really needs it but it
is public API
2010-08-14 14:52:18 -04:00
Mike Bayer 646bb7ae37 - added much more verbiage about transactions and expire_all 2010-08-12 10:47:07 -04:00
Mike Bayer a9288ca5bd working with how this will be documented and having some probs with sphinx 2010-08-09 20:49:08 -04:00
Mike Bayer 331141d936 get slightly better about deprecations in docstrings, tho this is kind of an uphill climb 2010-08-09 20:32:37 -04:00
Mike Bayer d47ec4158d fixes, but still unsure of things 2010-08-08 19:56:45 -04:00
Mike Bayer bb5a85feca merge tip 2010-08-08 17:50:44 -04:00
Mike Bayer c71513ce42 introductions 2010-08-08 13:57:18 -04:00
Mike Bayer bc8787a351 fixes, clarifications, removal of misleading statements 2010-08-03 12:26:56 -04:00
Mike Bayer e616c2fb3c - if @classproperty is used with a regular class-bound
mapper property attribute, it will be called to get the
actual attribute value during initialization. Currently,
there's no advantage to using @classproperty on a column
or relationship attribute of a declarative class that
isn't a mixin - evaluation is at the same time as if
@classproperty weren't used. But here we at least allow
it to function as expected.
- docs for column_property() with declarative
- mixin docs in declarative made more clear - mixins
are optional - each subsection starts with, "in *declarative mixins*",
to reduce confusion
2010-08-02 15:29:31 -04:00
Mike Bayer 0b9afe1412 merge from tip 2010-08-02 11:32:04 -04:00
Mike Bayer 2f844f231c - worked through about 25% of mappers.rst to implement
up to date and clear explanations of things, including
as much context and description as possible
2010-08-01 20:55:44 -04:00
Mike Bayer 62b12e4266 reformatting /cleanup of column type docs, including [ticket:1858] 2010-08-01 15:00:58 -04:00
Mike Bayer 2b12a8b0ed make this point about clear_mappers 2010-08-01 11:22:28 -04:00
Mike Bayer 693e2dcacf - worked it out so that classes declare a nested class "event",
with methods representing events.  This is self-documenting via sphinx.
- implemented new model for pool, classmanager.   Most events are
one or two args, so going back to allowing any kind of *arg, **kw
signature for events - this is simpler and improves performance,
though we don't get the "we can add new kw's anytime".  perhaps
there's some other way to approach that.
2010-07-24 17:55:06 -04:00
Mike Bayer 199fb1dd38 document the crap out of text(), Session.execute() 2010-07-20 11:54:58 -04:00
Mike Bayer f92cfd0681 - PG doc updates
- pypostgresql has 15 errors, 3 failures, this probably
puts it in the "yes" as opposed to the "partial" support
category.  [ticket:1850]
2010-07-13 21:30:55 -04:00
Mike Bayer 63249b6560 biginteger 2010-07-10 12:04:17 -04:00
Mike Bayer ce9ba7fdd3 - more 78 chars
- BIGINT doc
- clean up docs in schema.py
2010-07-10 11:47:30 -04:00
Mike Bayer 145a3c627c some prep for the 'viewcode' plugin, which works, though not sure if its helpful 2010-07-04 18:52:34 -04:00
Mike Bayer 55ae7d7842 - Added support for @classproperty to provide
any kind of schema/mapping construct from a
declarative mixin, including columns with foreign
keys, relationships, column_property, deferred.
This solves all such issues on declarative mixins.
An error is raised if any MapperProperty subclass
is specified on a mixin without using @classproperty.
[ticket:1751] [ticket:1796] [ticket:1805]

- un-anglicized the declarative docs
2010-07-03 14:53:37 -04:00
Mike Bayer 5a58907c99 replace all occurences of "closes the connection" "closes the transaction"
with explicit verbiage regarding "returns the connection to the connection
pool", "rolls back the transaction"
2010-06-29 19:02:49 -04:00
Mike Bayer 8895922b57 add make_transient 2010-06-29 11:24:15 -04:00
Mike Bayer 50420bf731 fix accessors, [ticket:1816] 2010-06-19 13:29:16 -04:00
Mike Bayer 7378611832 - added documentation for Inspector [ticket:1820]
- fixed "toplevel" regexp to include tokens of the form foo-bar-toplevel (i.e. multiple dashes)
- some CSS adjustment so that all API headings are in gray.
2010-06-13 15:49:27 -04:00
Mike Bayer 145e3bc584 - tweak to work with sphinx 1.0b2
- more open ended language for bound metadata
2010-06-08 15:53:13 -04:00
Mike Bayer b086f9a815 - Re-established support for Oracle 8 with cx_oracle,
including that use_ansi is set to False automatically,
NVARCHAR2 and NCLOB are not rendered for Unicode,
"native unicode" check doesn't fail, cx_oracle
"native unicode" mode is disabled, VARCHAR() is emitted
with bytes count instead of char count. [ticket:1808]
2010-05-27 13:02:17 -04:00
Mike Bayer 726f7a9f59 new link for pymssql #1810 2010-05-21 17:05:06 -04:00
Mike Bayer 28aa32a20d docs on dispose 2010-05-15 16:12:14 -04:00
Mike Bayer d997bbaea8 add more insert examples #1791 2010-05-03 22:18:27 -04:00
Mike Bayer 591a049cd3 update language regarding the behavior of expire/refresh with regards to relationships, [ticket:1762] 2010-04-14 17:58:08 -04:00
Chris Withers 5114807408 docs for new mixin class control abilities 2010-04-13 16:46:07 +01:00
Chris Withers 6fa48a7db1 wire in utility docs 2010-04-13 12:47:37 +01:00
Chris Withers ae16d89f7c add utility docs 2010-04-13 12:47:12 +01:00
Chris Withers 22be31ec3a stop Sphinx whining about this file, I believe it's used direct from a template 2010-04-13 12:05:45 +01:00
Chris Withers 36c05de373 made this easier to read 2010-04-09 18:02:06 +01:00
Mike Bayer 543b9837b3 spacing 2010-03-28 13:37:08 -04:00