Menu
▾
▴
[SQL-CVS] r1505 - SQLObject/docs
|
From: <sub...@co...> - 2006-01-13 09:38:03
|
Author: phd
Date: 2006-01-13 02:29:03 -0700 (Fri, 13 Jan 2006)
New Revision: 1505
Modified:
SQLObject/docs/SQLObject.txt
Log:
Fixed reST formatting.
Modified: SQLObject/docs/SQLObject.txt
===================================================================
--- SQLObject/docs/SQLObject.txt 2006-01-13 09:28:39 UTC (rev 1504)
+++ SQLObject/docs/SQLObject.txt 2006-01-13 09:29:03 UTC (rev 1505)
@@ -412,7 +412,7 @@
<Address 1 ...>
>>> p.addresses
[<Address 1 ...>]
-
+
.. note::
MultipleJoin, as well as RelatedJoin, returns a list of results.
Would you prefer to get a SelectResults objects, you should use
@@ -483,7 +483,7 @@
methods add/removesomething may not work as expected. Assuming that
you are providing the join with the correct joinColumn and otherColumn
arguments, be aware it's not possibile to insert extra data via such
-methodos, nor will they set any default value.
+methodos, nor will they set any default value.
Let's have an example: in the previous User/Role system,
you're creating a UserRole intermediate table, with the two columns
@@ -661,8 +661,8 @@
`table`:
The name of the table in the database. This is derived from
- ``style`` and the class name if no explicit name is given. If you
- don't give a name and haven't defined an alternative ``style``, then
+ ``style`` and the class name if no explicit name is given. If you
+ don't give a name and haven't defined an alternative ``style``, then
the standard `MixedCase` to `mixed_case` translation is performed.
`idName`:
@@ -675,10 +675,10 @@
is ``int`` by default (all IDs are normalized to integers).
`style`:
- A style object -- this object allows you to use other algorithms
+ A style object -- this object allows you to use other algorithms
for translating between Python attribute and class names, and the
database's column and table names. See `Changing the Naming
- Style`_ for more. It is an instance of the `IStyle` interface.
+ Style`_ for more. It is an instance of the `IStyle` interface.
`lazyUpdate`:
A boolean (default false). If true, then setting attributes on
@@ -700,9 +700,9 @@
If set to `False` then values for attributes from the database
won't be cached. So every time you access an attribute in the
object the database will be queried for a value, i.e., a ``SELECT``
- will be issued. If you want to handle concurrent access to the
- database from multiple processes then this is probably the way to
- do so. You should also use it with transactions_ (it is not
+ will be issued. If you want to handle concurrent access to the
+ database from multiple processes then this is probably the way to
+ do so. You should also use it with transactions_ (it is not
implied).
`registry`:
@@ -742,10 +742,10 @@
attributes are accessed a query will be run.
-While in previous versions of SQLObject those attributes were defined
+While in previous versions of SQLObject those attributes were defined
directly at the class that will map your database data to Python and
all of them were prefixed with an underscore, now it is suggested that
-you change your code to this new style. The old way will be removed
+you change your code to this new style. The old way will be removed
when SQLObject 0.8 is out and you'll receive lots of warning messages
saying that if you're not using the ``sqlmeta`` class you're doing things
in a deprecated way.
@@ -788,11 +788,11 @@
SQLObject Class
---------------
-Besides sqlmeta and columns specifications, there are a number of other
+Besides sqlmeta and columns specifications, there are a number of other
special attributes you can set in your class. Those are listed below but,
except for the ``_connection`` attribute, all other are superseded by the
implementation shown before with sqlmeta. If you use them with SQLObject
-0.7 you'll get warnings about their deprecation and you'll probably have
+0.7 you'll get warnings about their deprecation and you'll probably have
to convert your code in future releases, when these are dropped.
`_connection`:
@@ -816,7 +816,7 @@
from sqlmeta class.
`_cacheValues`:
- This is old style and works the same way as the `cacheValues`
+ This is old style and works the same way as the `cacheValues`
attribute from sqlmeta class.
.. _idName:
@@ -978,7 +978,7 @@
Undefined attributes
~~~~~~~~~~~~~~~~~~~~
-There's one more thing worth telling, because you may something get
+There's one more thing worth telling, because you may something get
strange results when making a typo. SQLObject won't ever complain or
raise any error when setting a previously undefined attribute; it will
simply set it, without making any change to the database, i.e: it will
@@ -1080,12 +1080,12 @@
Base-10, precise number. Uses the keyword arguments `size` for
number of digits stored, and `precision` for the number of digits
after the decimal point.
- WARNING: it may happen that DecimalCol values, although correctly
- stored in the DB, are returned as floats instead of decimals.
- You should test with your database adapter, and you should try
- importing the Decimal type and your DB adapter before importing
- SQLObject.
-
+ WARNING: it may happen that DecimalCol values, although correctly
+ stored in the DB, are returned as floats instead of decimals.
+ You should test with your database adapter, and you should try
+ importing the Decimal type and your DB adapter before importing
+ SQLObject.
+
`EnumCol`:
One of several string values -- give the possible strings as a
list, with the `enumValues` keyword argument. MySQL has a native
@@ -1158,7 +1158,7 @@
into 'product_no_id' in the DB ( product_no is the normal uppercase-
to-lowercase + underscores SQLO Translation, the added _id is just
because the column referring to the table is probably a ForeignKey,
- and SQLO translates foreign keys that way).
+ and SQLO translates foreign keys that way).
You should pass that parameter.
`orderBy`:
Like the `orderBy`_ argument to `select()`, you can specify
@@ -1195,20 +1195,20 @@
`removeRole(role)` are created. The ``Role`` portion of these
method names can be changed by giving a string value here.
`createRelatedTable`:
- default: ``True``. If ``False``, then the related table won't be
- automatically created; instead you must manually create it (e.g.,
- with explicit SQLObject classes for the joins). New in 0.7.1.
+ default: ``True``. If ``False``, then the related table won't be
+ automatically created; instead you must manually create it (e.g.,
+ with explicit SQLObject classes for the joins). New in 0.7.1.
.. note::
- Let's suppose you have SQLObject-inherited classes Alpha and Beta,
- and an AlphasAndBetas used for the many-to-many relationship.
+ Let's suppose you have SQLObject-inherited classes Alpha and Beta,
+ and an AlphasAndBetas used for the many-to-many relationship.
AlphasAndBetas contains the alphaIndex Foreign Key column referring
to Alpha, and the betaIndex FK column referring to Beta.
if you want a 'betas' RelatedJoin in Alpha, you should add it to
Alpha passing 'Beta' (class name!) as the first parameter, then
- passing 'alpha_index_id' as joinColumn, 'beta_index_id' as
+ passing 'alpha_index_id' as joinColumn, 'beta_index_id' as
otherColumn, and 'alphas_and_betas' as intermediateTable.
-
+
__ `Many-to-Many Relationships`_
An example schema that requires the use of `joinColumn`, `otherColumn`,
|
