diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2017-11-03 14:45:18 -0400 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2017-11-03 14:45:18 -0400 |
| commit | 75bdcd096f12012bf45cffebd597c33b501c2ef2 (patch) | |
| tree | 6c7f021f96a31de1271040045929ab72f18f9f2d /lib/sqlalchemy/dialects/postgresql | |
| parent | 152522b3f28de290d9ea2903fa2c414b8579515a (diff) | |
| download | sqlalchemy-75bdcd096f12012bf45cffebd597c33b501c2ef2.tar.gz | |
Fix as many RST parse warnings as possible.
Still a few I can't get. Also 0.9 is EOL so hide the
unreleased notes.
Change-Id: If0e44d4a0b3e78e211f32d5c33b51b1a007c9c69
Diffstat (limited to 'lib/sqlalchemy/dialects/postgresql')
| -rw-r--r-- | lib/sqlalchemy/dialects/postgresql/dml.py | 67 | ||||
| -rw-r--r-- | lib/sqlalchemy/dialects/postgresql/psycopg2.py | 14 |
2 files changed, 41 insertions, 40 deletions
diff --git a/lib/sqlalchemy/dialects/postgresql/dml.py b/lib/sqlalchemy/dialects/postgresql/dml.py index bfdfbfa36..503e29024 100644 --- a/lib/sqlalchemy/dialects/postgresql/dml.py +++ b/lib/sqlalchemy/dialects/postgresql/dml.py @@ -54,40 +54,41 @@ class Insert(StandardInsert): required, but only one of these can be specified. :param constraint: - The name of a unique or exclusion constraint on the table, - or the constraint object itself if it has a .name attribute. + The name of a unique or exclusion constraint on the table, + or the constraint object itself if it has a .name attribute. :param index_elements: - A sequence consisting of string column names, :class:`.Column` - objects, or other column expression objects that will be used - to infer a target index. + A sequence consisting of string column names, :class:`.Column` + objects, or other column expression objects that will be used + to infer a target index. :param index_where: - Additional WHERE criterion that can be used to infer a - conditional target index. + Additional WHERE criterion that can be used to infer a + conditional target index. :param set_: - Required argument. A dictionary or other mapping object - with column names as keys and expressions or literals as values, - specifying the ``SET`` actions to take. - If the target :class:`.Column` specifies a ".key" attribute distinct - from the column name, that key should be used. - - .. warning:: This dictionary does **not** take into account - Python-specified default UPDATE values or generation functions, - e.g. those specified using :paramref:`.Column.onupdate`. - These values will not be exercised for an ON CONFLICT style of - UPDATE, unless they are manually specified in the - :paramref:`.Insert.on_conflict_do_update.set_` dictionary. + Required argument. A dictionary or other mapping object + with column names as keys and expressions or literals as values, + specifying the ``SET`` actions to take. + If the target :class:`.Column` specifies a ".key" attribute distinct + from the column name, that key should be used. + + .. warning:: This dictionary does **not** take into account + Python-specified default UPDATE values or generation functions, + e.g. those specified using :paramref:`.Column.onupdate`. + These values will not be exercised for an ON CONFLICT style of + UPDATE, unless they are manually specified in the + :paramref:`.Insert.on_conflict_do_update.set_` dictionary. :param where: - Optional argument. If present, can be a literal SQL - string or an acceptable expression for a ``WHERE`` clause - that restricts the rows affected by ``DO UPDATE SET``. Rows - not meeting the ``WHERE`` condition will not be updated - (effectively a ``DO NOTHING`` for those rows). + Optional argument. If present, can be a literal SQL + string or an acceptable expression for a ``WHERE`` clause + that restricts the rows affected by ``DO UPDATE SET``. Rows + not meeting the ``WHERE`` condition will not be updated + (effectively a ``DO NOTHING`` for those rows). + + .. versionadded:: 1.1 - .. versionadded:: 1.1 .. seealso:: @@ -109,19 +110,19 @@ class Insert(StandardInsert): are optional, but only one of these can be specified. :param constraint: - The name of a unique or exclusion constraint on the table, - or the constraint object itself if it has a .name attribute. + The name of a unique or exclusion constraint on the table, + or the constraint object itself if it has a .name attribute. :param index_elements: - A sequence consisting of string column names, :class:`.Column` - objects, or other column expression objects that will be used - to infer a target index. + A sequence consisting of string column names, :class:`.Column` + objects, or other column expression objects that will be used + to infer a target index. :param index_where: - Additional WHERE criterion that can be used to infer a - conditional target index. + Additional WHERE criterion that can be used to infer a + conditional target index. - .. versionadded:: 1.1 + .. versionadded:: 1.1 .. seealso:: diff --git a/lib/sqlalchemy/dialects/postgresql/psycopg2.py b/lib/sqlalchemy/dialects/postgresql/psycopg2.py index 8ac39c201..f538cd98d 100644 --- a/lib/sqlalchemy/dialects/postgresql/psycopg2.py +++ b/lib/sqlalchemy/dialects/postgresql/psycopg2.py @@ -5,12 +5,11 @@ # This module is part of SQLAlchemy and is released under # the MIT License: http://www.opensource.org/licenses/mit-license.php -""" +r""" .. dialect:: postgresql+psycopg2 :name: psycopg2 :dbapi: psycopg2 - :connectstring: postgresql+psycopg2://user:password@host:port/dbname\ -[?key=value&key=value...] + :connectstring: postgresql+psycopg2://user:password@host:port/dbname[?key=value&key=value...] :url: http://pypi.python.org/pypi/psycopg2/ psycopg2 Connect Arguments @@ -31,6 +30,7 @@ psycopg2-specific keyword arguments which are accepted by Note that the :paramref:`.Connection.execution_options.stream_results` execution option is a more targeted way of enabling this mode on a per-execution basis. + * ``use_native_unicode``: Enable the usage of Psycopg2 "native unicode" mode per connection. True by default. @@ -56,7 +56,8 @@ psycopg2-specific keyword arguments which are accepted by * ``use_batch_mode``: This flag allows ``psycopg2.extras.execute_batch`` for ``cursor.executemany()`` calls performed by the :class:`.Engine`. It is currently experimental but - may well become True by default as it is critical for executemany performance. + may well become True by default as it is critical for executemany + performance. .. seealso:: @@ -79,10 +80,9 @@ using ``host`` as an additional keyword argument:: create_engine("postgresql+psycopg2://user:password@/dbname?\ host=/var/lib/postgresql") -See also: +.. seealso:: -`PQconnectdbParams <http://www.postgresql.org/docs/9.1/static/\ -libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS>`_ + `PQconnectdbParams <http://www.postgresql.org/docs/9.1/static/libpq-connect.html#LIBPQ-PQCONNECTDBPARAMS>`_ .. _psycopg2_execution_options: |
