#
# You can set these variables from the command line.
-SPHINXOPTS = -v
+SPHINXOPTS = -j auto -v
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = output
-
=============
0.7 Changelog
=============
.. changelog::
:version: 0.7.11
+ :released:
.. change::
:tags: bug, engine
:tickets: 2851
:versions: 0.8.3, 0.9.0b1
- The regexp used by the :func:`~sqlalchemy.engine.url.make_url` function now parses
- ipv6 addresses, e.g. surrounded by brackets.
+ The regexp used by the :func:`~sqlalchemy.engine.url.make_url` function now parses
+ ipv6 addresses, e.g. surrounded by brackets.
.. change::
:tags: bug, orm
:tickets: 2807
:versions: 0.8.3, 0.9.0b1
- Fixed bug where list instrumentation would fail to represent a
- setslice of ``[0:0]`` correctly, which in particular could occur
- when using ``insert(0, item)`` with the association proxy. Due
- to some quirk in Python collections, the issue was much more likely
- with Python 3 rather than 2.
+ Fixed bug where list instrumentation would fail to represent a
+ setslice of ``[0:0]`` correctly, which in particular could occur
+ when using ``insert(0, item)`` with the association proxy. Due
+ to some quirk in Python collections, the issue was much more likely
+ with Python 3 rather than 2.
.. change::
:tags: bug, sql
:tickets: 2801
:versions: 0.8.3, 0.9.0b1
- Fixed regression dating back to 0.7.9 whereby the name of a CTE might
- not be properly quoted if it was referred to in multiple FROM clauses.
+ Fixed regression dating back to 0.7.9 whereby the name of a CTE might
+ not be properly quoted if it was referred to in multiple FROM clauses.
.. change::
:tags: mysql, bug
:tickets: 2791
:versions: 0.8.3, 0.9.0b1
- Updates to MySQL reserved words for versions 5.5, 5.6, courtesy
- Hanno Schlichting.
+ Updates to MySQL reserved words for versions 5.5, 5.6, courtesy
+ Hanno Schlichting.
.. change::
:tags: sql, bug, cte
:tickets: 2783
:versions: 0.8.3, 0.9.0b1
- Fixed bug in common table expression system where if the CTE were
- used only as an ``alias()`` construct, it would not render using the
- WITH keyword.
+ Fixed bug in common table expression system where if the CTE were
+ used only as an ``alias()`` construct, it would not render using the
+ WITH keyword.
.. change::
:tags: bug, sql
:tickets: 2784
:versions: 0.8.3, 0.9.0b1
- Fixed bug in :class:`.CheckConstraint` DDL where the "quote" flag from a
- :class:`.Column` object would not be propagated.
+ Fixed bug in :class:`.CheckConstraint` DDL where the "quote" flag from a
+ :class:`.Column` object would not be propagated.
.. change::
:tags: bug, orm
-
=============
0.8 Changelog
=============
.. include:: changelog_08.rst
:start-line: 5
+
.. include:: changelog_07.rst
:start-line: 5
+
.. _unreleased_changelog::
:version: 0.9.11
-
-
=============
1.0 Changelog
=============
.. include:: changelog_09.rst
:start-line: 5
+
.. include:: changelog_08.rst
:start-line: 5
+
.. include:: changelog_07.rst
:start-line: 5
+
.. changelog::
:version: 1.0.19
:released: August 3, 2017
.. include:: changelog_10.rst
:start-line: 5
+
.. include:: changelog_09.rst
:start-line: 5
+
.. include:: changelog_08.rst
:start-line: 5
+
.. include:: changelog_07.rst
:start-line: 5
+
.. changelog::
:version: 1.1.19
:include_notes_from: unreleased_11
.. include:: changelog_11.rst
:start-line: 5
+
.. include:: changelog_10.rst
:start-line: 5
+
.. changelog::
:version: 1.2.20
:include_notes_from: unreleased_12
:ticket:`2320`
:attr:`.Column.key` is honored in the :attr:`.Select.c` attribute of :func:`.select` with :meth:`.Select.apply_labels`
------------------------------------------------------------------------------------------------------------------------
+--------------------------------------------------------------------------------------------------------------------------------
Users of the expression system know that :meth:`.Select.apply_labels`
prepends the table name to each column name, affecting the
.. _metadata_constraints_toplevel:
.. _metadata_constraints:
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
================================
Defining Constraints and Indexes
-.. module:: sqlalchemy.types
+.. currentmodule:: sqlalchemy.types
.. _types_custom:
.. _metadata_ddl_toplevel:
.. _metadata_ddl:
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
Customizing DDL
===============
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
.. _metadata_defaults_toplevel:
with :class:`.UpdateBase`. The :class:`.Insert` and :class:`.Update`
constructs build on the intermediary :class:`.ValuesBase`.
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
.. autofunction:: delete
SQL and Generic Functions
=========================
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
SQL functions which are known to SQLAlchemy with regards to database-specific
rendering, return types and argument behavior. Generic functions are invoked
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
.. _metadata_reflection_toplevel:
.. _metadata_reflection:
Schema Definition Language
==========================
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
This section references SQLAlchemy **schema metadata**, a comprehensive system of describing and inspecting
database schemas.
a namespace of all the columns contained within the FROM clause (these
elements are themselves :class:`.ColumnElement` subclasses).
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
.. autofunction:: alias
Column Elements and Expressions
===============================
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
The expression API consists of a series of classes each of which represents a
specific lexical element within a SQL string. Composed together
-.. module:: sqlalchemy.types
+.. currentmodule:: sqlalchemy.types
.. _types_api:
and techniques.
.. _largecollections:
-.. currentmodule:: sqlalchemy.orm
Working with Large Collections
==============================
:paramref:`.orm.mapper.passive_deletes` - similar feature on :func:`.mapper`
.. currentmodule:: sqlalchemy.orm.collections
+
.. _custom_collections:
Customizing Collection Access
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
.. _mapper_composite:
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
.. _mapping_constructors:
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
===============
Loading Columns
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
Changing Attribute Behavior
===========================
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
.. _mapper_sql_expressions:
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
Class Mapping API
=================
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
Mapping Table Columns
=====================
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
.. _query_api_toplevel:
-.. automodule:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
Relationships API
-----------------
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
.. _relationship_config_toplevel:
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
===============================
Mapping Columns and Expressions
-.. module:: sqlalchemy.orm.session
+.. currentmodule:: sqlalchemy.orm.session
Session API
===========
return self._execution_options
def execute(self, *multiparams, **params):
- """Compile and execute this :class:`.Executable`."""
+ """Compile and execute this :class:`.Executable`.
+
+ """
e = self.bind
if e is None:
label = getattr(self, "description", self.__class__.__name__)
"Inherited from :func:`sqlalchemy%s`; this constructor "
"creates a :class:`%s` object"
% (linked_to_location, class_location),
- 0,
+ 1,
)
decorated.__doc__ = linked_to_doc
else:
def inject_docstring_text(doctext, injecttext, pos):
doctext = _dedent_docstring(doctext or "")
lines = doctext.split("\n")
+ if len(lines) == 1:
+ lines.append("")
injectlines = textwrap.dedent(injecttext).split("\n")
if injectlines[0]:
injectlines.insert(0, "")
projects / thirdparty / sqlalchemy / sqlalchemy.git / commitdiff
