From: Federico Caselli Date: Fri, 17 Jun 2022 19:53:32 +0000 (+0200) Subject: Normalize postgresql docs links to point to current X-Git-Tag: rel_1_4_38~6^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=61662b25b87d3973eb5bcc1b5c0d2f5908f24405;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Normalize postgresql docs links to point to current Change-Id: Ib7d3ea7ff3356ff8a2f935892d904a69dbc25c3e (cherry picked from commit 3bde1eae31212b5bc2c6652dca52f70fb79d5950) --- diff --git a/doc/build/changelog/migration_07.rst b/doc/build/changelog/migration_07.rst index 12a3c23e6d..a222f5380b 100644 --- a/doc/build/changelog/migration_07.rst +++ b/doc/build/changelog/migration_07.rst @@ -373,8 +373,7 @@ The best introduction to window functions is on PostgreSQL's site, where window functions have been supported since version 8.4: -https://www.postgresql.org/docs/9.0/static/tutorial- -window.html +https://www.postgresql.org/docs/current/static/tutorial-window.html SQLAlchemy provides a simple construct typically invoked via an existing function clause, using the ``over()`` method, diff --git a/doc/build/orm/versioning.rst b/doc/build/orm/versioning.rst index a141df6a0c..30388eb8d2 100644 --- a/doc/build/orm/versioning.rst +++ b/doc/build/orm/versioning.rst @@ -45,7 +45,7 @@ transaction). .. seealso:: - `Repeatable Read Isolation Level `_ - PostgreSQL's implementation of repeatable read, including a description of the error condition. + `Repeatable Read Isolation Level `_ - PostgreSQL's implementation of repeatable read, including a description of the error condition. Simple Version Counting ----------------------- @@ -141,7 +141,7 @@ some means of generating new identifiers when a row is subject to an INSERT as well as with an UPDATE. For the UPDATE case, typically an update trigger is needed, unless the database in question supports some other native version identifier. The PostgreSQL database in particular supports a system -column called `xmin `_ +column called `xmin `_ which provides UPDATE versioning. We can make use of the PostgreSQL ``xmin`` column to version our ``User`` class as follows:: diff --git a/lib/sqlalchemy/dialects/postgresql/base.py b/lib/sqlalchemy/dialects/postgresql/base.py index 92d9e263e8..db88d9e6a8 100644 --- a/lib/sqlalchemy/dialects/postgresql/base.py +++ b/lib/sqlalchemy/dialects/postgresql/base.py @@ -409,7 +409,7 @@ which is in the ``public`` (i.e. default) schema will always have the from a backend-agnostic perspective `The Schema Search Path - `_ + `_ - on the PostgreSQL website. INSERT/UPDATE...RETURNING @@ -735,7 +735,7 @@ produces a statement equivalent to:: It's important to remember that text searching in PostgreSQL is powerful but complicated, and SQLAlchemy users are advised to reference the PostgreSQL documentation regarding - `Full Text Search `_. + `Full Text Search `_. There are important differences between ``to_tsquery`` and ``plainto_tsquery``, the most significant of which is that ``to_tsquery`` @@ -789,6 +789,11 @@ It is recommended that you use the ``EXPLAIN ANALYZE...`` tool from PostgreSQL to ensure that you are generating queries with SQLAlchemy that take full advantage of any indexes you may have created for full text search. +.. seealso:: + + `Full Text Search `_ - in the PostgreSQL documentation + + FROM ONLY ... ------------- @@ -849,7 +854,7 @@ Operator Classes PostgreSQL allows the specification of an *operator class* for each column of an index (see -https://www.postgresql.org/docs/8.3/interactive/indexes-opclass.html). +https://www.postgresql.org/docs/current/interactive/indexes-opclass.html). The :class:`.Index` construct allows these to be specified via the ``postgresql_ops`` keyword argument:: @@ -891,7 +896,7 @@ Index Types PostgreSQL provides several index types: B-Tree, Hash, GiST, and GIN, as well as the ability for users to create their own (see -https://www.postgresql.org/docs/8.3/static/indexes-types.html). These can be +https://www.postgresql.org/docs/current/static/indexes-types.html). These can be specified on :class:`.Index` using the ``postgresql_using`` keyword argument:: Index('my_index', my_table.c.data, postgresql_using='gin') diff --git a/lib/sqlalchemy/dialects/postgresql/ext.py b/lib/sqlalchemy/dialects/postgresql/ext.py index c3bda33b92..9e52ee1ee9 100644 --- a/lib/sqlalchemy/dialects/postgresql/ext.py +++ b/lib/sqlalchemy/dialects/postgresql/ext.py @@ -93,7 +93,7 @@ class ExcludeConstraint(ColumnCollectionConstraint): Defines an EXCLUDE constraint as described in the `PostgreSQL documentation`__. - __ https://www.postgresql.org/docs/9.0/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE + __ https://www.postgresql.org/docs/current/static/sql-createtable.html#SQL-CREATETABLE-EXCLUDE """ # noqa diff --git a/lib/sqlalchemy/dialects/postgresql/psycopg2.py b/lib/sqlalchemy/dialects/postgresql/psycopg2.py index 663a17b2aa..bacd60bbef 100644 --- a/lib/sqlalchemy/dialects/postgresql/psycopg2.py +++ b/lib/sqlalchemy/dialects/postgresql/psycopg2.py @@ -110,7 +110,7 @@ using ``host`` as an additional keyword argument:: .. seealso:: `PQconnectdbParams \ - `_ + `_ .. _psycopg2_multi_host: @@ -135,7 +135,7 @@ or all connections are unsuccessful in which case an error is raised. .. seealso:: `PQConnString \ - `_ + `_ Empty DSN Connections / Environment Variable Connections --------------------------------------------------------- diff --git a/lib/sqlalchemy/dialects/postgresql/ranges.py b/lib/sqlalchemy/dialects/postgresql/ranges.py index 35cf360cff..51f3b0489f 100644 --- a/lib/sqlalchemy/dialects/postgresql/ranges.py +++ b/lib/sqlalchemy/dialects/postgresql/ranges.py @@ -18,7 +18,7 @@ class RangeOperators(object): provided in the ``postgres`` dialect and can likely be used for any range types you create yourself. - __ https://www.postgresql.org/docs/devel/static/functions-range.html + __ https://www.postgresql.org/docs/current/static/functions-range.html No extra support is provided for the Range Functions listed in the Range Functions table of the PostgreSQL documentation. For these, the normal diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index ba5e448acd..0ab3912065 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -511,7 +511,7 @@ class Query( Here is the `PostgreSQL WITH RECURSIVE example - `_. + `_. Note that, in this example, the ``included_parts`` cte and the ``incl_alias`` alias of it are Core selectables, which means the columns are accessed via the ``.c.`` attribute. The diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py index bc7e65d90c..b36ae6e8a5 100644 --- a/lib/sqlalchemy/sql/schema.py +++ b/lib/sqlalchemy/sql/schema.py @@ -3749,8 +3749,8 @@ class ForeignKeyConstraint(ColumnCollectionConstraint): ) else: # e.g. FOREIGN KEY (a) REFERENCES r (b, c) - # paraphrasing https://www.postgresql.org/docs/9.2/static/\ - # ddl-constraints.html + # paraphrasing + # https://www.postgresql.org/docs/current/static/ddl-constraints.html raise exc.ArgumentError( "ForeignKeyConstraint number " "of constrained columns must match the number of " diff --git a/lib/sqlalchemy/sql/sqltypes.py b/lib/sqlalchemy/sql/sqltypes.py index 306ac397df..edb9c676d2 100644 --- a/lib/sqlalchemy/sql/sqltypes.py +++ b/lib/sqlalchemy/sql/sqltypes.py @@ -862,8 +862,8 @@ class DateTime(_LookupExpressionAdapter, TypeEngine): @util.memoized_property def _expression_adaptations(self): - # Based on https://www.postgresql.org/docs/current/\ - # static/functions-datetime.html. + # Based on + # https://www.postgresql.org/docs/current/static/functions-datetime.html. return { operators.add: {Interval: self.__class__}, @@ -886,8 +886,8 @@ class Date(_LookupExpressionAdapter, TypeEngine): @util.memoized_property def _expression_adaptations(self): - # Based on https://www.postgresql.org/docs/current/\ - # static/functions-datetime.html. + # Based on + # https://www.postgresql.org/docs/current/static/functions-datetime.html. return { operators.add: { @@ -934,8 +934,8 @@ class Time(_LookupExpressionAdapter, TypeEngine): @util.memoized_property def _expression_adaptations(self): - # Based on https://www.postgresql.org/docs/current/\ - # static/functions-datetime.html. + # Based on + # https://www.postgresql.org/docs/current/static/functions-datetime.html. return { operators.add: {Date: DateTime, Interval: self.__class__}, @@ -2014,8 +2014,8 @@ class Boolean(Emulated, TypeEngine, SchemaType): class _AbstractInterval(_LookupExpressionAdapter, TypeEngine): @util.memoized_property def _expression_adaptations(self): - # Based on https://www.postgresql.org/docs/current/\ - # static/functions-datetime.html. + # Based on + # https://www.postgresql.org/docs/current/static/functions-datetime.html. return { operators.add: { diff --git a/test/dialect/postgresql/test_reflection.py b/test/dialect/postgresql/test_reflection.py index 3502c745b2..bf8cd51111 100644 --- a/test/dialect/postgresql/test_reflection.py +++ b/test/dialect/postgresql/test_reflection.py @@ -1091,7 +1091,7 @@ class ReflectionTest( # "ASC NULLS LAST" is implicit default for indexes, # and "NULLS FIRST" is implicit default for "DESC". - # (https://www.postgresql.org/docs/11/indexes-ordering.html) + # (https://www.postgresql.org/docs/current/indexes-ordering.html) def compile_exprs(exprs): return list(map(str, exprs))