summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2015-12-14 18:01:32 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2015-12-14 18:02:14 -0500
commit80bbf139597ecf3581cf7a64ad40679c54b509a8 (patch)
tree73806c80f67705a0ed3e4690e059b3c29c890b01
parentd0fc7269888247517ffa16d9472f961ebec892a7 (diff)
downloadsqlalchemy-80bbf139597ecf3581cf7a64ad40679c54b509a8.tar.gz
- a few tweaks to allow "server_defaults" to be a little more linkable;
remove "undoc members" that was putting some random server_default atributes from ColumnClause (cherry picked from commit 270301890ae87ec32a46bb17889d9776b7de1468)
-rw-r--r--doc/build/core/defaults.rst2
-rw-r--r--doc/build/core/metadata.rst5
-rw-r--r--lib/sqlalchemy/sql/schema.py12
3 files changed, 12 insertions, 7 deletions
diff --git a/doc/build/core/defaults.rst b/doc/build/core/defaults.rst
index 4166ac449..e0e566654 100644
--- a/doc/build/core/defaults.rst
+++ b/doc/build/core/defaults.rst
@@ -195,6 +195,8 @@ collection contains a list of primary key values for the row inserted (a list
so that single-column and composite-column primary keys are represented in the
same format).
+.. _server_defaults:
+
Server Side Defaults
--------------------
diff --git a/doc/build/core/metadata.rst b/doc/build/core/metadata.rst
index c04de158b..1eade1c1c 100644
--- a/doc/build/core/metadata.rst
+++ b/doc/build/core/metadata.rst
@@ -306,26 +306,21 @@ Column, Table, MetaData API
.. autoclass:: Column
:members:
:inherited-members:
- :undoc-members:
.. autoclass:: MetaData
:members:
- :undoc-members:
.. autoclass:: SchemaItem
:members:
- :undoc-members:
.. autoclass:: Table
:members:
:inherited-members:
- :undoc-members:
.. autoclass:: ThreadLocalMetaData
:members:
- :undoc-members:
diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py
index 25eb68f6f..42dbe72b2 100644
--- a/lib/sqlalchemy/sql/schema.py
+++ b/lib/sqlalchemy/sql/schema.py
@@ -990,8 +990,12 @@ class Column(SchemaItem, ColumnClause):
a positional argument; see that class for full detail on the
structure of the argument.
- Contrast this argument to ``server_default`` which creates a
- default generator on the database side.
+ Contrast this argument to :paramref:`.Column.server_default`
+ which creates a default generator on the database side.
+
+ .. seealso::
+
+ :ref:`metadata_defaults_toplevel`
:param doc: optional String that can be used by the ORM or similar
to document attributes. This attribute does not render SQL
@@ -1057,6 +1061,10 @@ class Column(SchemaItem, ColumnClause):
construct does not specify any DDL and the implementation is left
to the database, such as via a trigger.
+ .. seealso::
+
+ :ref:`server_defaults`
+
:param server_onupdate: A :class:`.FetchedValue` instance
representing a database-side default generation function. This
indicates to SQLAlchemy that a newly generated value will be