Commit Graph

575 Commits

Author SHA1 Message Date
Mike Bayer 609d8e8bc3 - VERSION moves just as a string in __version__
- added modified sphinx.sty with plain Verbatim section
- link to pdf doc in site
2008-12-10 21:27:21 +00:00
Mike Bayer 70f55bd2cd - restored the previous API Reference structure
- bumped latex TOC structure, the PDF looks great
- but we need to fix the translate_connect_args docstring bug to really have PDF
2008-12-08 21:32:29 +00:00
Mike Bayer 082d5db64f - removed redundant declarative docs
- cleanup of metadata/foreignkey docs
2008-12-08 20:21:02 +00:00
Mike Bayer dd91a165cc - restored the main search form
- fixed search highlighting
- the url docstring works again from a ReST perspective, still not PDF
2008-12-08 00:20:20 +00:00
Mike Bayer 480436ff7c - moved index.rst around to have the API docs right there, no "Main Documentation" chapter which is fairly needless. this all allows PDF to have a decent TOC on the side with only two levels (can we change that ?)
- added LatexFormatter.
- PDF wont work until issue with the docstirng in url.py/URL.translate_connect_args is fixed.
2008-12-07 23:58:02 +00:00
Mike Bayer 058c2895be worked schema into sections 2008-12-07 21:10:27 +00:00
Mike Bayer 9bab01d37b - convert __init__ and :members: to be compatible with autoclass_content='both' 2008-12-07 20:13:26 +00:00
Mike Bayer ee7fcf3110 - re-documented Table and Column constructors, fixed case sensitivity description [ticket:1231]
- turned on autoclass_content="both".  Need to specify __init__ docstring with a newline after the """.
- other docs
2008-12-07 06:30:00 +00:00
Jason Kirtland bdf0117578 Adjusted basis for refs. 2008-12-07 06:26:36 +00:00
Mike Bayer 994ab27aa3 - postgres docstring
- insert/update/delete are documented generatively
- values({}) is no longer deprecated, thus enabling
unicode/Columns as keys
2008-12-06 18:27:04 +00:00
Jason Kirtland de4ed96ec0 Enabled sphinx doctests. 2008-12-06 17:47:20 +00:00
Mike Bayer 65390f035a remove old files 2008-12-06 17:00:17 +00:00
Mike Bayer 1c329624a5 - merged -r5338:5429 of sphinx branch.
- Documentation has been converted to Sphinx.
In particular, the generated API documentation
has been constructed into a full blown
"API Reference" section which organizes
editorial documentation combined with
generated docstrings.   Cross linking between
sections and API docs are vastly improved,
a javascript-powered search feature is
provided, and a full index of all
classes, functions and members is provided.
2008-12-06 16:59:48 +00:00
Mike Bayer e3502f7f9d deprecated CompositeProperty 'comparator' which is now
named 'comparator_factory'.
2008-11-24 01:44:08 +00:00
Mike Bayer 6c8af5108e one more select_table... 2008-11-24 01:21:08 +00:00
Mike Bayer 75e8350e4d - comparator_factory is accepted by all MapperProperty constructors. [ticket:1149]
- added other unit tests as per [ticket:1149]
- rewrote most of the "joined table inheritance" documentation section, removed badly out of
date "polymorphic_fetch" and "select_table" arguments.
- "select_table" raises a deprecation warning.  converted unit tests to not use it.
- removed all references to "ORDER BY table.oid" from mapping docs.
- renamed PropertyLoader to RelationProperty.  Old symbol remains.
- renamed ColumnProperty.ColumnComparator to ColumnProperty.Comparator.  Old symbol remains.
2008-11-24 01:14:32 +00:00
Mike Bayer 2c69cdb350 - Tickets [ticket:1200].
- Added note about create_session() defaults.

- Added section about metadata.reflect().

- Updated `TypeDecorator` section.

- Rewrote the "threadlocal" strategy section of
the docs due to recent confusion over this
feature.

- ordered the init arguments in the docs for sessionmaker().

- other edits
2008-11-22 19:22:42 +00:00
Mike Bayer f03e4ca595 prevent extra nested li items from becoming tiny 2008-11-22 17:46:03 +00:00
Michael Trier 097f76b465 Doing my part-time editorial duties. Normalized session references and fixed lots of small spelling and grammar issues. 2008-11-12 03:05:13 +00:00
Mike Bayer cfca625e94 docstring updates 2008-11-07 22:36:21 +00:00
Mike Bayer 0a48075161 - added serializer docs to plugins.txt
- CHANGES formatting
2008-11-07 18:43:39 +00:00
Mike Bayer c3352e5542 - Fixed bug in Query involving order_by() in conjunction with
multiple aliases of the same class (will add tests in
[ticket:1218])
- Added a new extension sqlalchemy.ext.serializer.  Provides
Serializer/Deserializer "classes" which mirror Pickle/Unpickle,
as well as dumps() and loads().  This serializer implements
an "external object" pickler which keeps key context-sensitive
objects, including engines, sessions, metadata, Tables/Columns,
and mappers, outside of the pickle stream, and can later
restore the pickle using any engine/metadata/session provider.
This is used not for pickling regular object instances, which are
pickleable without any special logic, but for pickling expression
objects and full Query objects, such that all mapper/engine/session
dependencies can be restored at unpickle time.
2008-11-06 23:07:47 +00:00
Mike Bayer 9f894d2f26 - Dialects can now generate label names of adjustable length.
Pass in the argument "label_length=<value>" to create_engine()
to adjust how many characters max will be present in dynamically
generated column labels, i.e. "somecolumn AS somelabel".  Any
value less than 6 will result in a label of minimal size,
consiting of an underscore and a numeric counter.
The compiler uses the value of dialect.max_identifier_length
as a default. [ticket:1211]
- removed ANON_NAME regular expression, using string patterns now
- _generated_label() unicode subclass is used to indicate generated names
which are subject to truncation
2008-11-05 20:50:48 +00:00
Jason Kirtland 837f71eca5 Fixed assoc proxy examples [ticket:1191] 2008-11-02 22:50:12 +00:00
Michael Trier aa6c4df395 Corrected typo in Types docs. 2008-10-28 18:09:22 +00:00
Michael Trier 3d0fe5bfe2 Demonstrate mssql url examples for the database engine documentation. Closes #1198. 2008-10-23 02:09:27 +00:00
Michael Trier c4da034f7e Included documentation about the defaults for create_session() and how they differ from sessionmaker(). Closes #1197. 2008-10-23 01:47:44 +00:00
Michael Trier 86c3992318 Added in sqlite3 DBAPI to the SQLite dbengine docs. This along with a wiki edit on Database Features should close #1145. 2008-10-05 13:28:56 +00:00
Michael Trier f0a40280fd Corrected docs for declarative synonym incorrectly referring to instruments instead of descriptor. 2008-10-05 03:30:58 +00:00
Mike Bayer 17309da8e6 fixed custom TypeEngine example 2008-09-27 21:15:51 +00:00
Mike Bayer 36570c6595 - Dropped 0.3-compatibility for user defined types
(convert_result_value, convert_bind_param).
2008-09-07 00:13:28 +00:00
Mike Bayer c164c174a5 correction 2008-09-02 19:59:55 +00:00
Mike Bayer 3829b89d69 - column_property(), composite_property(), and relation() now
accept a single or list of AttributeExtensions using the
"extension" keyword argument.
- Added a Validator AttributeExtension, as well as a
@validates decorator which is used in a similar fashion
as @reconstructor, and marks a method as validating
one or more mapped attributes.
- removed validate_attributes example, the new methodology replaces it
2008-09-02 19:51:48 +00:00
Michael Trier c99d54e762 Corrected typo in the mapper docs. Fixes #1159. 2008-08-28 14:21:07 +00:00
Jason Kirtland 0b4b2454af Type processors get a dialect, not an engine... 2008-08-27 19:10:03 +00:00
Gaëtan de Menten 90ba350099 - Fix occurences of Class.c.column_name
- Fix a few typos/mistakes
- removed trailing whitespaces
- tried to achieve a more consistent syntax for spaces in properties
  declaration
2008-08-21 09:12:54 +00:00
Jason Kirtland 2d4908e88c - Renamed on_reconstitute to @reconstructor and reconstruct_instance
- Moved @reconstructor hooking to mapper
- Expanded reconstructor tests, docs
2008-08-15 22:03:42 +00:00
Mike Bayer 7897dd9827 added info on named tuples 2008-08-12 14:55:38 +00:00
Mike Bayer bf43d45cea added col with no name example 2008-08-11 18:00:10 +00:00
Mike Bayer d55d29329e - The composite() property type now supports
a __set_composite_values__() method on the composite
class which is required if the class represents
state using attribute names other than the
column's keynames; default-generated values now
get populated properly upon flush.  Also,
composites with attributes set to None compare
correctly.  [ticket:1132]
2008-08-11 17:18:10 +00:00
Lele Gaifax 28ff190475 Typo 2008-08-04 13:17:40 +00:00
Mike Bayer e53339cf74 some doc stuff 2008-08-04 03:05:26 +00:00
Mike Bayer 4769ea895b - renamed autoexpire to expire_on_commit
- renamed SessionTransaction autoflush to reentrant_flush to more clearly state its purpose
- added _enable_transaction_accounting, flag for Mike Bernson which disables the whole 0.5 transaction state management; the system depends on expiry on rollback in order to function.
2008-08-03 18:03:57 +00:00
Mike Bayer d28ba32271 - The "entity_name" feature of SQLAlchemy mappers
has been removed.  For rationale, see
http://groups.google.com/group/sqlalchemy/browse_thread/thread/9e23a0641a88b96d?hl=en
2008-08-02 22:21:42 +00:00
Jason Kirtland 8c261ab7b7 - declarative.declarative_base():
takes a 'metaclass' arg, defaulting to DeclarativeMeta
  renamed 'engine' arg to 'bind', backward compat
  documented
2008-08-02 16:32:02 +00:00
Gaëtan de Menten fd51706903 typo 2008-07-29 08:43:30 +00:00
Michael Trier 5c75aed9be Corrected a couple of lingering transactional=True statements in the docs. 2008-07-19 17:52:31 +00:00
Michael Trier f899157ca9 Added new basic match() operator that performs a full-text search. Supported on PostgreSQL, SQLite, MySQL, MS-SQL, and Oracle backends. 2008-07-13 04:45:37 +00:00
Jason Kirtland 4611ad6889 Let doc font sizes adapt to browser prefs (experimental) 2008-07-10 20:31:19 +00:00
Jason Kirtland f299d9ea04 Flag beta docs with a big red capsule 2008-07-10 18:32:38 +00:00