'zzzeeksphinx',
'changelog',
'sphinx_paramlinks',
- 'corrections'
+ #'corrections'
]
# Add any paths that contain templates here, relative to this directory.
"sqlalchemy.sql.selectable": "sqlalchemy.sql.expression",
"sqlalchemy.sql.dml": "sqlalchemy.sql.expression",
"sqlalchemy.sql.ddl": "sqlalchemy.schema",
- "sqlalchemy.sql.base": "sqlalchemy.sql.expression"
+ "sqlalchemy.sql.base": "sqlalchemy.sql.expression",
+ "sqlalchemy.engine.base": "sqlalchemy.engine",
+ "sqlalchemy.engine.result": "sqlalchemy.engine",
}
autodocmods_convert_modname_w_class = {
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
+html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Connection / Engine API
=======================
+.. autoclass:: BaseRowProxy
+ :members:
+
.. autoclass:: Connection
:members:
.. autoclass:: Engine
:members:
-.. autoclass:: sqlalchemy.engine.ExceptionContext
+.. autoclass:: ExceptionContext
:members:
.. autoclass:: NestedTransaction
:members:
-.. autoclass:: sqlalchemy.engine.ResultProxy
+.. autoclass:: ResultProxy
:members:
-.. autoclass:: sqlalchemy.engine.RowProxy
+.. autoclass:: RowProxy
:members:
.. autoclass:: Transaction
Defining Constraints and Indexes
=================================
-.. _metadata_foreignkeys:
-
This section will discuss SQL :term:`constraints` and indexes. In SQLAlchemy
the key classes include :class:`.ForeignKeyConstraint` and :class:`.Index`.
+.. _metadata_foreignkeys:
+
Defining Foreign Keys
---------------------
.. autoclass:: DDLElement
:members:
:undoc-members:
-
+
.. autoclass:: DDL
:members:
:undoc-members:
-
+
+
+.. autoclass:: _DDLCompiles
+ :members:
+
+
+.. autoclass:: _CreateDropBase
+ :members:
.. autoclass:: CreateTable
:members:
:undoc-members:
-
+
.. autoclass:: DropTable
:members:
:undoc-members:
-
+
.. autoclass:: CreateColumn
:members:
:undoc-members:
-
+
.. autoclass:: CreateSequence
:members:
:undoc-members:
-
+
.. autoclass:: DropSequence
:members:
:undoc-members:
-
+
.. autoclass:: CreateIndex
:members:
:undoc-members:
-
+
.. autoclass:: DropIndex
:members:
:undoc-members:
-
+
.. autoclass:: AddConstraint
:members:
:undoc-members:
-
+
.. autoclass:: DropConstraint
:members:
:undoc-members:
-
+
.. autoclass:: CreateSchema
:members:
:undoc-members:
-
+
.. autoclass:: DropSchema
:members:
:undoc-members:
-
+
.. automodule:: sqlalchemy.sql.functions
:members:
:undoc-members:
-
+ :exclude-members: func
+
.. currentmodule: sqlalchemy
+.. autoclass:: sqlalchemy.schema.ColumnCollectionMixin
+ :members:
+
.. autoclass:: sqlalchemy.engine.interfaces.Compiled
:members:
:members:
+.. autoclass:: sqlalchemy.log.Identified
+ :members:
+
+
.. autoclass:: sqlalchemy.sql.compiler.IdentifierPreparer
:members:
.. autoclass:: sqlalchemy.orm.attributes.Event
:members:
-
.. autoclass:: sqlalchemy.orm.interfaces._InspectionAttr
:members:
+.. autoclass:: sqlalchemy.orm.identity.IdentityMap
+ :members:
.. autoclass:: sqlalchemy.orm.state.InstanceState
:members:
The Postgresql text search functions such as ``to_tsquery()``
and ``to_tsvector()`` are available
-explicitly using the standard :attr:`.func` construct. For example::
+explicitly using the standard :data:`.func` construct. For example::
select([
func.to_tsvector('fat cats ate rats').match('cat & rat')
)
from .result import (
+ BaseRowProxy,
BufferedColumnResultProxy,
BufferedColumnRow,
BufferedRowResultProxy,
a subclass of :class:`.Executable`, such as a
:func:`~.expression.select` construct
* a :class:`.FunctionElement`, such as that generated
- by :attr:`.func`, will be automatically wrapped in
+ by :data:`.func`, will be automatically wrapped in
a SELECT statement, which is then executed.
* a :class:`.DDLElement` object
* a :class:`.DefaultGenerator` object
return func.abs(cls.length) / 2
Above the Python function ``abs()`` is used for instance-level
-operations, the SQL function ``ABS()`` is used via the :attr:`.func`
+operations, the SQL function ``ABS()`` is used via the :data:`.func`
object for class-level expressions::
>>> i1.radius
UniqueConstraint,
_get_table_key,
ColumnCollectionConstraint,
+ ColumnCollectionMixin
)
:class:`.DDLEvents`
- :mod:`sqlalchemy.event`
+ :ref:`event_toplevel`
"""
The construction of :meth:`.TypeEngine.with_variant` is always
from the "fallback" type to that which is dialect specific.
The returned type is an instance of :class:`.Variant`, which
- itself provides a :meth:`~sqlalchemy.types.Variant.with_variant`
+ itself provides a :meth:`.Variant.with_variant`
that can be called repeatedly.
:param type_: a :class:`.TypeEngine` that will be selected