#
# You can set these variables from the command line.
-SPHINXOPTS = -j auto -v
+SPHINXOPTS = -j auto
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = output
The behavior of =/!= when comparing a scalar select
to a value will no longer produce IN/NOT IN as of 0.8;
- this behavior is a little too heavy handed (use in_() if
+ this behavior is a little too heavy handed (use ``in_()`` if
you want to emit IN) and now emits a deprecation warning.
To get the 0.8 behavior immediately and remove the warning,
a compiler recipe is given at
:tickets: 2957
:versions: 0.9.3
- Fixed bug where :meth:`.in_()` would go into an endless loop if
- erroneously passed a column expression whose comparator included
- the ``__getitem__()`` method, such as a column that uses the
+ Fixed bug where :meth:`.ColumnOperators.in_()` would go into an endless
+ loop if erroneously passed a column expression whose comparator
+ included the ``__getitem__()`` method, such as a column that uses the
:class:`.postgresql.ARRAY` type.
.. change::
:tickets: 3459
Added a :meth:`.ColumnElement.cast` method which performs the same
- purpose as the standalone :func:`.cast` function. Pull request
- courtesy Sebastian Bank.
+ purpose as the standalone :func:`.expression.cast` function. Pull
+ request courtesy Sebastian Bank.
.. change::
:tags: bug, engine
Repaired the :class:`.ExcludeConstraint` construct to support common
features that other objects like :class:`.Index` now do, that
the column expression may be specified as an arbitrary SQL
- expression such as :obj:`.cast` or :obj:`.text`.
+ expression such as :obj:`.expression.cast` or :obj:`.expression.text`.
.. change::
:tags: feature, postgresql
:tags: bug, orm
:tickets: 3448
- Fixed an unexpected-use regression whereby custom :class:`.Comparator`
- objects that made use of the ``__clause_element__()`` method and
- returned an object that was an ORM-mapped
- :class:`.InstrumentedAttribute` and not explicitly a
- :class:`.ColumnElement` would fail to be correctly
- handled when passed as an expression to :meth:`.Session.query`.
- The logic in 0.9 happened to succeed on this, so this use case is now
- supported.
+ Fixed an unexpected-use regression whereby custom
+ :class:`.types.TypeEngine.Comparator` objects that made use of the
+ ``__clause_element__()`` method and returned an object that was an
+ ORM-mapped :class:`.InstrumentedAttribute` and not explicitly a
+ :class:`.ColumnElement` would fail to be correctly handled when passed
+ as an expression to :meth:`.Session.query`. The logic in 0.9 happened
+ to succeed on this, so this use case is now supported.
.. change::
:tags: bug, sql
:released: May 28, 2018
.. change::
- :tags: bug, orm
- :tickets: 4256
+ :tags: bug, orm
+ :tickets: 4256
- Fixed regression in 1.2.7 caused by :ticket:`4228`, which itself was fixing
- a 1.2-level regression, where the ``query_cls`` callable passed to a
- :class:`.Session` was assumed to be a subclass of :class:`.Query` with
- class method availability, as opposed to an arbitrary callable. In
- particular, the dogpile caching example illustrates ``query_cls`` as a
- function and not a :class:`.Query` subclass.
+ Fixed regression in 1.2.7 caused by :ticket:`4228`, which itself was fixing
+ a 1.2-level regression, where the ``query_cls`` callable passed to a
+ :class:`.Session` was assumed to be a subclass of :class:`.Query` with
+ class method availability, as opposed to an arbitrary callable. In
+ particular, the dogpile caching example illustrates ``query_cls`` as a
+ function and not a :class:`.Query` subclass.
.. change::
:tags: bug, engine
.. change::
- :tags: bug, ext
- :tickets: 4247
+ :tags: bug, ext
+ :tickets: 4247
- The horizontal sharding extension now makes use of the identity token
- added to ORM identity keys as part of :ticket:`4137`, when an object
- refresh or column-based deferred load or unexpiration operation occurs.
- Since we know the "shard" that the object originated from, we make
- use of this value when refreshing, thereby avoiding queries against
- other shards that don't match this object's identity in any case.
+ The horizontal sharding extension now makes use of the identity token
+ added to ORM identity keys as part of :ticket:`4137`, when an object
+ refresh or column-based deferred load or unexpiration operation occurs.
+ Since we know the "shard" that the object originated from, we make
+ use of this value when refreshing, thereby avoiding queries against
+ other shards that don't match this object's identity in any case.
.. change::
:tags: bug, sql
of these issues as part of issue :ticket:`4258`.
.. change::
- :tags: bug, ext
- :tickets: 4266
+ :tags: bug, ext
+ :tickets: 4266
- Fixed a race condition which could occur if automap
- :meth:`.AutomapBase.prepare` were used within a multi-threaded context
- against other threads which may call :func:`.configure_mappers` as a
- result of use of other mappers. The unfinished mapping work of automap
- is particularly sensitive to being pulled in by a
- :func:`.configure_mappers` step leading to errors.
+ Fixed a race condition which could occur if automap
+ :meth:`.AutomapBase.prepare` were used within a multi-threaded context
+ against other threads which may call :func:`.configure_mappers` as a
+ result of use of other mappers. The unfinished mapping work of automap
+ is particularly sensitive to being pulled in by a
+ :func:`.configure_mappers` step leading to errors.
.. change::
:tags: bug, orm
the post criteria feature is now used by the lazy loader.
.. change::
- :tags: bug, tests
- :tickets: 4249
+ :tags: bug, tests
+ :tickets: 4249
- Fixed a bug in the test suite where if an external dialect returned
- ``None`` for ``server_version_info``, the exclusion logic would raise an
- ``AttributeError``.
+ Fixed a bug in the test suite where if an external dialect returned
+ ``None`` for ``server_version_info``, the exclusion logic would raise an
+ ``AttributeError``.
.. change::
:tags: bug, orm
index implicitly added by Oracle onto the primary key columns.
.. change::
- :tags: bug, orm
- :tickets: 4071
+ :tags: bug, orm
+ :tickets: 4071
- Removed the warnings that are emitted when the LRU caches employed
- by the mapper as well as loader strategies reach their threshold; the
- purpose of this warning was at first a guard against excess cache keys
- being generated but became basically a check on the "creating many
- engines" antipattern. While this is still an antipattern, the presence
- of test suites which both create an engine per test as well as raise
- on all warnings will be an inconvenience; it should not be critical
- that such test suites change their architecture just for this warning
- (though engine-per-test suite is always better).
+ Removed the warnings that are emitted when the LRU caches employed
+ by the mapper as well as loader strategies reach their threshold; the
+ purpose of this warning was at first a guard against excess cache keys
+ being generated but became basically a check on the "creating many
+ engines" antipattern. While this is still an antipattern, the presence
+ of test suites which both create an engine per test as well as raise
+ on all warnings will be an inconvenience; it should not be critical
+ that such test suites change their architecture just for this warning
+ (though engine-per-test suite is always better).
.. change::
:tags: bug, orm
Internal refinements to the :class:`.Enum`, :class:`.Interval`, and
:class:`.Boolean` types, which now extend a common mixin
:class:`.Emulated` that indicates a type that provides Python-side
- emulation of a DB native type, switching out to the DB native type when a
- supporting backend is in use. The PostgreSQL :class:`.INTERVAL` type
- when used directly will now include the correct type coercion rules for
- SQL expressions that also take effect for :class:`.sqltypes.Interval`
- (such as adding a date to an interval yields a datetime).
+ emulation of a DB native type, switching out to the DB native type when
+ a supporting backend is in use. The PostgreSQL
+ :class:`.postgresql.INTERVAL` type when used directly will now include
+ the correct type coercion rules for SQL expressions that also take
+ effect for :class:`.sqltypes.Interval` (such as adding a date to an
+ interval yields a datetime).
.. change::
.. seealso::
- :ref:`of_type`
+ :ref:`inheritance_of_type`
:ticket:`2438` :ticket:`1106`
:ticket:`2276`
"Prefixes" now supported for :func:`.update`, :func:`.delete`
--------------------------------------------------------------
+----------------------------------------------------------------------------
Geared towards MySQL, a "prefix" can be rendered within any of
these constructs. E.g.::
.. _migration_2736:
:meth:`.Query.select_from` no longer applies the clause to corresponding entities
----------------------------------------------------------------------------------
+-----------------------------------------------------------------------------------------------
The :meth:`.Query.select_from` method has been popularized in recent versions
as a means of controlling the first thing that a :class:`.Query` object
-- 0.9 behavior
x = :x_1 COLLATE en_EN
-The potentially backwards incompatible change arises if the :meth:`.collate`
-operator is being applied to the right-hand column, as follows::
+The potentially backwards incompatible change arises if the
+:meth:`.ColumnOperators.collate` operator is being applied to the right-hand
+column, as follows::
print(column('x') == literal('somevalue').collate("en_EN"))
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys
import os
+import sys
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../../lib'))
-sys.path.insert(0, os.path.abspath('../..')) # examples
-sys.path.insert(0, os.path.abspath('.'))
-
-import sqlalchemy
+sys.path.insert(0, os.path.abspath("../../lib"))
+sys.path.insert(0, os.path.abspath("../..")) # examples
+sys.path.insert(0, os.path.abspath("."))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = '1.6.0'
+needs_sphinx = "1.6.0"
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
- 'sphinx.ext.autodoc',
- 'zzzeeksphinx',
- 'changelog',
- 'sphinx_paramlinks',
- ]
+ "sphinx.ext.autodoc",
+ "zzzeeksphinx",
+ "changelog",
+ "sphinx_paramlinks",
+]
+needs_extensions = {"zzzeeksphinx": "1.1.2"}
# Add any paths that contain templates here, relative to this directory.
# not sure why abspath() is needed here, some users
# have reported this.
-templates_path = [os.path.abspath('templates')]
+templates_path = [os.path.abspath("templates")]
-nitpicky = True
+nitpicky = False
# The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
# section names used by the changelog extension.
-changelog_sections = ["general", "orm", "orm declarative", "orm querying", \
- "orm configuration", "engine", "sql", \
- "schema", \
- "postgresql", "mysql", "sqlite", "mssql", \
- "oracle", "firebird"]
+changelog_sections = [
+ "general",
+ "orm",
+ "orm declarative",
+ "orm querying",
+ "orm configuration",
+ "engine",
+ "sql",
+ "schema",
+ "postgresql",
+ "mysql",
+ "sqlite",
+ "mssql",
+ "oracle",
+ "firebird",
+]
# tags to sort on inside of sections
changelog_inner_tag_sort = ["feature", "changed", "removed", "bug", "moved"]
changelog_render_changeset = "http://www.sqlalchemy.org/trac/changeset/%s"
exclude_patterns = [
- 'build',
- '**/unreleased*/*',
+ "build",
+ "**/unreleased*/*",
]
+# zzzeeksphinx makes these conversions when it is rendering the
+# docstrings classes, methods, and functions within the scope of
+# Sphinx autodoc
autodocmods_convert_modname = {
"sqlalchemy.sql.sqltypes": "sqlalchemy.types",
"sqlalchemy.sql.type_api": "sqlalchemy.types",
"sqlalchemy.sql.dml": "sqlalchemy.sql.expression",
"sqlalchemy.sql.ddl": "sqlalchemy.schema",
"sqlalchemy.sql.base": "sqlalchemy.sql.expression",
+ "sqlalchemy.event.base": "sqlalchemy.event",
"sqlalchemy.engine.base": "sqlalchemy.engine",
"sqlalchemy.engine.result": "sqlalchemy.engine",
+ "sqlalchemy.util._collections": "sqlalchemy.util",
}
autodocmods_convert_modname_w_class = {
("sqlalchemy.sql.base", "DialectKWArgs"): "sqlalchemy.sql.base",
}
+# on the referencing side, a newer zzzeeksphinx extension
+# applies shorthand symbols to references so that we can have short
+# names that are still using absolute references.
+zzzeeksphinx_module_prefixes = {
+ "_sa": "sqlalchemy",
+ "_engine": "sqlalchemy.engine",
+ "_schema": "sqlalchemy.schema",
+ "_types": "sqlalchemy.types",
+ "_expression": "sqlalchemy.sql.expression",
+ "_functions": "sqlalchemy.sql.functions",
+ "_pool": "sqlalchemy.pool",
+ "_event": "sqlalchemy.event",
+ "_events": "sqlalchemy.events",
+ "_exc": "sqlalchemy.exc",
+ "_reflection": "sqlalchemy.engine.reflection",
+ "_orm": "sqlalchemy.orm",
+ "_query": "sqlalchemy.orm.query",
+ "_ormevent": "sqlalchemy.orm.event",
+ "_ormexc": "sqlalchemy.orm.exc",
+ "_baked": "sqlalchemy.ext.baked",
+ "_associationproxy": "sqlalchemy.ext.associationproxy",
+ "_automap": "sqlalchemy.ext.automap",
+ "_hybrid": "sqlalchemy.ext.hybrid",
+ "_compilerext": "sqlalchemy.ext.compiler",
+ "_mutable": "sqlalchemy.ext.mutable",
+ "_declarative": "sqlalchemy.ext.declarative",
+ "_future": "sqlalchemy.future",
+ "_futureorm": "sqlalchemy.future.orm",
+ "_postgresql": "sqlalchemy.dialects.postgresql",
+ "_mysql": "sqlalchemy.dialects.mysql",
+ "_mssql": "sqlalchemy.dialects.mssql",
+ "_oracle": "sqlalchemy.dialects.oracle",
+ "_sqlite": "sqlalchemy.dialects.sqlite",
+}
+
+
# The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
# The master toctree document.
-master_doc = 'contents'
+master_doc = "contents"
# General information about the project.
-project = u'SQLAlchemy'
-copyright = u'2007-2019, the SQLAlchemy authors and contributors'
+project = u"SQLAlchemy"
+copyright = u"2007-2019, the SQLAlchemy authors and contributors"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = None
+# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
-#today = ''
+# today = ''
# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
# have the "gettext" build generate .pot for each individual
# .rst
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'zzzeeksphinx'
+html_theme = "zzzeeksphinx"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
-html_style = 'default.css'
+html_style = "default.css"
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "%s %s Documentation" % (project, version)
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-#html_logo = None
+# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
-#html_favicon = None
+# html_favicon = None
# 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,
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-html_last_updated_fmt = '%m/%d/%Y %H:%M:%S'
+html_last_updated_fmt = "%m/%d/%Y %H:%M:%S"
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
-html_additional_pages = {
- "notfound": "notfound.html"
-}
+html_additional_pages = {"notfound": "notfound.html"}
# If false, no module index is generated.
html_domain_indices = False
# If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
# If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# html_copy_source = True
html_copy_source = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
# Output file base name for HTML help builder.
-htmlhelp_basename = 'SQLAlchemydoc'
+htmlhelp_basename = "SQLAlchemydoc"
-#autoclass_content = 'both'
+# autoclass_content = 'both'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('contents', 'sqlalchemy_%s.tex' % release.replace('.', '_'), 'SQLAlchemy Documentation',
- 'Mike Bayer', 'manual'),
+ (
+ "contents",
+ "sqlalchemy_%s.tex" % release.replace(".", "_"),
+ "SQLAlchemy Documentation",
+ "Mike Bayer",
+ "manual",
+ ),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
-#latex_logo = None
+# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
# If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
# If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
# Additional stuff for the LaTeX preamble.
# sets TOC depth to 2.
-latex_preamble = '\setcounter{tocdepth}{3}'
+latex_preamble = "\setcounter{tocdepth}{3}"
# Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
# If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
-#latex_elements = {
+# latex_elements = {
# 'papersize': 'letterpaper',
# 'pointsize': '10pt',
-#}
+# }
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'sqlalchemy', u'SQLAlchemy Documentation',
- [u'SQLAlchemy authors'], 1)
+ (
+ "index",
+ "sqlalchemy",
+ u"SQLAlchemy Documentation",
+ [u"SQLAlchemy authors"],
+ 1,
+ )
]
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
-epub_title = u'SQLAlchemy'
-epub_author = u'SQLAlchemy authors'
-epub_publisher = u'SQLAlchemy authors'
-epub_copyright = u'2007-2015, SQLAlchemy authors'
+epub_title = u"SQLAlchemy"
+epub_author = u"SQLAlchemy authors"
+epub_publisher = u"SQLAlchemy authors"
+epub_copyright = u"2007-2015, SQLAlchemy authors"
# The language of the text. It defaults to the language option
# or en if the language is not set.
-#epub_language = ''
+# epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
+# epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
-#epub_identifier = ''
+# epub_identifier = ''
# A unique identification for the text.
-#epub_uid = ''
+# epub_uid = ''
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
-#epub_pre_files = []
+# epub_pre_files = []
# HTML files that should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
-#epub_post_files = []
+# epub_post_files = []
# A list of files that should not be packed into the epub file.
-#epub_exclude_files = []
+# epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
+# epub_tocdepth = 3
# Allow duplicate toc entries.
-#epub_tocdup = True
-
-
+# epub_tocdup = True
that, including the variety of SQL expression constructs described
in :ref:`sqlexpression_toplevel`.
+
Using Transactions
==================
.. autoclass:: Delete
:members:
- :inherited-members:
+
+ .. automethod:: Delete.where
+
+ .. automethod:: Delete.returning
.. autoclass:: Insert
:members:
- :inherited-members:
+
+ .. automethod:: Insert.values
+
+ .. automethod:: Insert.returning
.. autoclass:: Update
- :members:
- :inherited-members:
+ :members:
+
+ .. automethod:: Update.returning
+
+ .. automethod:: Update.where
+
+ .. automethod:: Update.values
.. autoclass:: sqlalchemy.sql.expression.UpdateBase
- :members:
- :inherited-members:
+ :members:
.. autoclass:: sqlalchemy.sql.expression.ValuesBase
:members:
======================
.. automodule:: sqlalchemy.inspection
- :members:
+
+.. autofunction:: sqlalchemy.inspect
+
Available Inspection Targets
----------------------------
.. autoclass:: Select
:members:
- :inherited-members:
+ :inherited-members: ClauseElement
+ :exclude-members: memoized_attribute, memoized_instancemethod
.. autoclass:: Selectable
:members:
.. autoclass:: SelectBase
:members:
- :inherited-members:
+ :inherited-members: ClauseElement
+ :exclude-members: memoized_attribute, memoized_instancemethod
.. autoclass:: TableClause
:members:
General ALTER support isn't present in SQLAlchemy directly. For special DDL
on an ad-hoc basis, the :class:`.DDL` and related constructs can be used.
-See :doc:`core/ddl` for a discussion on this subject.
+See :ref:`metadata_ddl_toplevel` for a discussion on this subject.
A more comprehensive option is to use schema migration tools, such as Alembic
or SQLAlchemy-Migrate; see :ref:`schema_migrations` for discussion on this.
that is, we see many expensive calls within the ``type_api`` system, and the actual
time consuming thing is the ``time.sleep()`` call.
-Make sure to check the :doc:`Dialect documentation <dialects/index>`
+Make sure to check the :ref:`Dialect documentation <dialect_toplevel>`
for notes on known performance tuning suggestions at this level, especially for
databases like Oracle. There may be systems related to ensuring numeric accuracy
or string processing that may not be needed in all cases.
For the use case of fast bulk inserts, the
SQL generation and execution system that the ORM builds on top of
-is part of the :doc:`Core <core/tutorial>`. Using this system directly, we can produce an INSERT that
+is part of the :ref:`Core <sqlexpression_toplevel>`. Using this system directly, we can produce an INSERT that
is competitive with using the raw database API directly.
.. note::
- When using the psycopg2 dialect, consider making use of the
- :ref:`batch execution helpers <psycopg2_batch_mode>` feature of psycopg2,
- now supported directly by the SQLAlchemy psycopg2 dialect.
+ When using the psycopg2 dialect, consider making use of the :ref:`batch
+ execution helpers <psycopg2_batch_mode>` feature of psycopg2, now
+ supported directly by the SQLAlchemy psycopg2 dialect.
Alternatively, the SQLAlchemy ORM offers the :ref:`bulk_operations`
suite of methods, which provide hooks into subsections of the unit of
:ref:`concrete_inheritance`
- :ref:`inheritance_concrete_helpers`
.. _relationship_non_primary_mapper:
+.. _relationship_aliased_class:
+
Relationship to Non Primary Mapper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: sqlalchemy.orm.util.identity_key
-.. autofunction:: sqlalchemy.orm.util.polymorphic_union
+.. autofunction:: polymorphic_union
-.. autoclass:: sqlalchemy.orm.mapper.Mapper
+.. autoclass:: Mapper
:members:
expired column-based attributes being accessed.
* Regarding relationships, :meth:`~.Session.refresh` is more restrictive than
- :meth:`~.Session.expire` with regards to attributes that aren't column-mapped.
- Calling :meth:`.refresh` and passing a list of names that only includes
+ :meth:`.Session.expire` with regards to attributes that aren't column-mapped.
+ Calling :meth:`.Session.refresh` and passing a list of names that only includes
relationship-mapped attributes will actually raise an error.
In any case, non-eager-loading :func:`.relationship` attributes will not be
included in any refresh operation.
allow this data to be visible." This means that it cannot be assumed that an
UPDATE that happened on another database connection will yet be visible here
locally; in many cases, it will not. This is why if one wishes to use
-:meth:`.expire` or :meth:`.refresh` in order to view data between ongoing
+:meth:`.Session.expire` or :meth:`.Session.refresh` in order to view data between ongoing
transactions, an understanding of the isolation behavior in effect is essential.
.. seealso::
--- /dev/null
+.MetaData _schema.MetaData
+.ForeignKey _schema.ForeignKey
+.ForeignKeyConstraint _schema.ForeignKeyConstraint
+.PoolEvents _events.PoolEvents
+.DisconnectionError _exc.DisconnectionError
+.SADeprecationWarning _exc.SADeprecationWarning
+.Engine _engine.Engine
+.Pool _pool.Pool
+.future _future
+.inspect _sa.inspect
+.Inspector _reflection.Inspector
+.orm _orm
+.Mapper _orm.Mapper
+.engine _engine
+.JSON _types.JSON
+.postgresql _postgresql
+.types _types
+._mysql _mysql
+.sqlite _sqlite
+.array_agg _functions.array_agg
+.TIMESTAMP _types.TIMESTAMP
+.JSONB _postgresql.JSONB
+.ARRAY _types.ARRAY
+.mssql _mssql
+.sqltypes _types
+.functions _functions
+.INTERVAL _postgresql.INTERVAL
+.INTERVAL _oracle.INTERVAL
+.oracle _oracle
+.NCHAR _types.NCHAR
+.Query _query.Query
+.relationship _orm.relationship
+.FromClause _expression.FromClause
+.join _expression.join
+.SelectBase _expression.SelectBase
+.Load _orm.Load
+.joinedload _orm.joinedload
+.sql _expression
+.sql.expression _expression
+.INTEGER _types.INTEGER
+.VARBINARY _types.VARBINARY
+.joinedload_all _orm.joinedload_all
+.Insert _expression.Insert
+.Update _expression.Update
+.Delete _expression.Delete
+.insert _expression.insert
+.update _expression.update
+.delete _expression.delete
+.select _expression.select
+.expression _expression
+.future _future.Subquery _expression.Subquery
+.Select _expression.Select
+.ReturnsRows _expression.ReturnsRows
+.ColumnCollection _expression.ColumnCollection
+.ColumnElement _expression.ColumnElement
+.Selectable expression.Selectable
+.Lateral _expression.Lateral
+.HasPrefixes _expression.HasPrefixes
+.prefix_with _expression.HasPrefixes.prefix_with
+.ClauseElement _expression.ClauseElement
+.HasSuffixes _expression.HasSuffixes
+.suffix_with _expression.HasSuffixes.suffix_with
+.Table _schema.Table
+.Join _expression.Join
+.Alias _expression.Alias
+.TableSample _expression.TableSample
+.CTE _expression.CTE
+.HasCte _expression.HasCTE
+.HasCTE _expression.HasCTE
+.CompoundSelect _selectable.CompoundSelect
+.TextualSelect _expression.TextualSelect
+.TableClause _expression.TableClause
+.schema _schema
+.Values _expression.Values
+.column _expression.column
+.GenerativeSelect _expression.GenerativeSelect
+.Column _schema.Column
+.union _expression.union
+.union_all _expression.union_all
+.intersect _expression.intersect
+.intersect_all _expression.intersect_all
+.except _expression.except
+.except_all _expression.except_all
+.Text _expression.TextClause
+.text _expression.text
+.literal_column _expression.literal_column
+.Connection _engine.Connection
+.Engine _engine.Engine
+.apply_labels _expression.Select.apply_labels
+.BooleanClauseList _expression.BooleanClauseList
+.ScalarSelect _expression.ScalarSelect
+.Exists _expression.Exists
+.TextClause _expression.TextClause
* Complete control over whether the "old" or "new" types are rendered is
available in all SQLAlchemy versions by using the UPPERCASE type objects
- instead: :class:`.NVARCHAR`, :class:`.VARCHAR`, :class:`.types.VARBINARY`,
- :class:`.TEXT`, :class:`.mssql.NTEXT`, :class:`.mssql.IMAGE` will always
- remain fixed and always output exactly that type.
+ instead: :class:`.types.NVARCHAR`, :class:`.types.VARCHAR`,
+ :class:`.types.VARBINARY`, :class:`.types.TEXT`, :class:`.mssql.NTEXT`,
+ :class:`.mssql.IMAGE` will always remain fixed and always output exactly that
+ type.
.. versionadded:: 1.0.0
ASSOCIATION_PROXY = util.symbol("ASSOCIATION_PROXY")
-"""Symbol indicating an :class:`InspectionAttr` that's
+"""Symbol indicating an :class:`.InspectionAttr` that's
of type :class:`.AssociationProxy`.
Is assigned to the :attr:`.InspectionAttr.extension_type`
:ref:`concrete_inheritance`
- :ref:`inheritance_concrete_helpers`
-
"""
:ref:`concrete_inheritance`
- :ref:`inheritance_concrete_helpers`
-
"""
__no_table__ = True
.. versionadded:: 0.9.0
- :var impl: The :class:`.AttributeImpl` which is the current event
+ :attribute impl: The :class:`.AttributeImpl` which is the current event
initiator.
- :var op: The symbol :attr:`.OP_APPEND`, :attr:`.OP_REMOVE`,
+ :attribute op: The symbol :attr:`.OP_APPEND`, :attr:`.OP_REMOVE`,
:attr:`.OP_REPLACE`, or :attr:`.OP_BULK_REPLACE`, indicating the
source operation.
self._unbound_fn = fn
fn_doc = self.fn.__doc__
self.fn.__doc__ = """Produce a new :class:`.Load` object with the
-:func:`.orm.%(name)s` option applied.
+:func:`_orm.%(name)s` option applied.
-See :func:`.orm.%(name)s` for usage examples.
+See :func:`_orm.%(name)s` for usage examples.
""" % {
"name": self.name
def _add_unbound_all_fn(self, fn):
self._unbound_all_fn = fn
- fn.__doc__ = """Produce a standalone "all" option for :func:`.orm.%(name)s`.
+ fn.__doc__ = """Produce a standalone "all" option for
+:func:`_orm.%(name)s`.
.. deprecated:: 0.9
- The :func:`.%(name)s_all` function is deprecated, and will be removed
- in a future release. Please use method chaining with :func:`.%(name)s`
- instead, as in::
+ The :func:`_orm.%(name)s_all` function is deprecated, and will be removed
+ in a future release. Please use method chaining with
+ :func:`_orm.%(name)s` instead, as in::
session.query(MyClass).options(
%(name)s("someattribute").%(name)s("anotherattribute")
.. seealso::
- :ref:`inheritance_polymorphic_load`
+ :ref:`polymorphic_selectin`
"""
loadopt.set_class_strategy(
prefixes=None,
**dialect_kw
):
- """Construct :class:`.Delete` object.
+ r"""Construct :class:`.Delete` object.
Similar functionality is available via the
:meth:`~.TableClause.delete` method on
message="The :meth:`.FromClause.count` method is deprecated, "
"and will be removed in a future release. Please use the "
":class:`.functions.count` function available from the "
- ":attr:`.func` namespace."
+ ":attr:`.func` namespace.",
)
@util.dependencies("sqlalchemy.sql.functions")
def count(self, functions, whereclause=None, **params):
"and will be removed in a future release. Please use the "
"the :paramref:`.Connection.execution_options.autocommit` "
"parameter in conjunction with the "
- ":meth:`.Executable.execution_options` method."
+ ":meth:`.Executable.execution_options` method.",
)
def autocommit(self):
"""return a new selectable with the 'autocommit' flag set to
All arguments which accept :class:`.ClauseElement` arguments also
accept string arguments, which will be converted as appropriate into
- either :func:`text()` or :func:`literal_column()` constructs.
+ either :func:`.text()` or :func:`.literal_column()` constructs.
.. seealso::
name += "()"
return name
- return re.sub(r"\:(\w+)\:`~?\.?(.+?)`", repl, text)
+ return re.sub(r"\:(\w+)\:`~?(?:_\w+)?\.?(.+?)`", repl, text)
def _decorate_with_warning(func, wtype, message, docstring_header=None):
usedevelop=
cov: True
-deps=pytest!=3.9.1,!=3.9.2
+deps=pytest!=3.9.1,!=3.9.2,<5.4
pytest-xdist
mock
# needed only for correct profiling results
setenv=
PYTHONPATH=
PYTHONNOUSERSITE=1
- BASECOMMAND=python -m pytest --log-info=sqlalchemy.testing
+ BASECOMMAND=python -m pytest --log-info=sqlalchemy.testing -k "not aaa_profiling"
WORKERS={env:TOX_WORKERS:-n4}
oracle,oracle6,oracle5: WORKERS={env:TOX_WORKERS:-n2}
projects / thirdparty / sqlalchemy / sqlalchemy.git / commitdiff
