diff options
Diffstat (limited to 'docs/ref/contrib/postgres')
| -rw-r--r-- | docs/ref/contrib/postgres/aggregates.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/fields.txt | 4 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/functions.txt | 2 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/indexes.txt | 37 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/lookups.txt | 6 | ||||
| -rw-r--r-- | docs/ref/contrib/postgres/search.txt | 12 |
6 files changed, 31 insertions, 32 deletions
diff --git a/docs/ref/contrib/postgres/aggregates.txt b/docs/ref/contrib/postgres/aggregates.txt index e66b771524..cbf3eada09 100644 --- a/docs/ref/contrib/postgres/aggregates.txt +++ b/docs/ref/contrib/postgres/aggregates.txt @@ -7,7 +7,7 @@ PostgreSQL specific aggregation functions These functions are available from the ``django.contrib.postgres.aggregates`` module. They are described in more detail in the `PostgreSQL docs -<https://www.postgresql.org/docs/current/static/functions-aggregate.html>`_. +<https://www.postgresql.org/docs/current/functions-aggregate.html>`_. .. note:: diff --git a/docs/ref/contrib/postgres/fields.txt b/docs/ref/contrib/postgres/fields.txt index a5c87bf8da..eb46074e1e 100644 --- a/docs/ref/contrib/postgres/fields.txt +++ b/docs/ref/contrib/postgres/fields.txt @@ -283,8 +283,8 @@ transform do not change. For example:: ``max_length`` won't be enforced in the database since ``citext`` behaves similar to PostgreSQL's ``text`` type. - .. _citext: https://www.postgresql.org/docs/current/static/citext.html - .. _the performance considerations: https://www.postgresql.org/docs/current/static/citext.html#AEN178177 + .. _citext: https://www.postgresql.org/docs/current/citext.html + .. _the performance considerations: https://www.postgresql.org/docs/current/citext.html#AEN178177 ``HStoreField`` =============== diff --git a/docs/ref/contrib/postgres/functions.txt b/docs/ref/contrib/postgres/functions.txt index 3b98e573e7..2c00ce8a1a 100644 --- a/docs/ref/contrib/postgres/functions.txt +++ b/docs/ref/contrib/postgres/functions.txt @@ -18,7 +18,7 @@ The `pgcrypto extension`_ must be installed. You can use the :class:`~django.contrib.postgres.operations.CryptoExtension` migration operation to install it. -.. _pgcrypto extension: https://www.postgresql.org/docs/current/static/pgcrypto.html +.. _pgcrypto extension: https://www.postgresql.org/docs/current/pgcrypto.html Usage example:: diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt index ef19384fb8..ce360c9501 100644 --- a/docs/ref/contrib/postgres/indexes.txt +++ b/docs/ref/contrib/postgres/indexes.txt @@ -13,14 +13,14 @@ available from the ``django.contrib.postgres.indexes`` module. .. class:: BrinIndex(autosummarize=None, pages_per_range=None, **options) Creates a `BRIN index - <https://www.postgresql.org/docs/current/static/brin-intro.html>`_. + <https://www.postgresql.org/docs/current/brin-intro.html>`_. Set the ``autosummarize`` parameter to ``True`` to enable `automatic summarization`_ to be performed by autovacuum. The ``pages_per_range`` argument takes a positive integer. - .. _automatic summarization: https://www.postgresql.org/docs/current/static/brin-intro.html#BRIN-OPERATION + .. _automatic summarization: https://www.postgresql.org/docs/current/brin-intro.html#BRIN-OPERATION .. versionchanged:: 2.2 @@ -38,20 +38,19 @@ available from the ``django.contrib.postgres.indexes`` module. Provide an integer value from 10 to 100 to the fillfactor_ parameter to tune how packed the index pages will be. PostgreSQL's default is 90. - .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS + .. _fillfactor: https://www.postgresql.org/docs/current/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS ``GinIndex`` ============ .. class:: GinIndex(fastupdate=None, gin_pending_list_limit=None, **options) - Creates a `gin index - <https://www.postgresql.org/docs/current/static/gin.html>`_. + Creates a `gin index <https://www.postgresql.org/docs/current/gin.html>`_. To use this index on data types not in the `built-in operator classes - <https://www.postgresql.org/docs/current/static/gin-builtin-opclasses.html>`_, + <https://www.postgresql.org/docs/current/gin-builtin-opclasses.html>`_, you need to activate the `btree_gin extension - <https://www.postgresql.org/docs/current/static/btree-gin.html>`_ on + <https://www.postgresql.org/docs/current/btree-gin.html>`_ on PostgreSQL. You can install it using the :class:`~django.contrib.postgres.operations.BtreeGinExtension` migration operation. @@ -63,8 +62,8 @@ available from the ``django.contrib.postgres.indexes`` module. to tune the maximum size of the GIN pending list which is used when ``fastupdate`` is enabled. This parameter requires PostgreSQL ≥ 9.5. - .. _GIN Fast Update Technique: https://www.postgresql.org/docs/current/static/gin-implementation.html#GIN-FAST-UPDATE - .. _gin_pending_list_limit: https://www.postgresql.org/docs/current/static/runtime-config-client.html#GUC-GIN-PENDING-LIST-LIMIT + .. _GIN Fast Update Technique: https://www.postgresql.org/docs/current/gin-implementation.html#GIN-FAST-UPDATE + .. _gin_pending_list_limit: https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-GIN-PENDING-LIST-LIMIT ``GistIndex`` ============= @@ -72,18 +71,18 @@ available from the ``django.contrib.postgres.indexes`` module. .. class:: GistIndex(buffering=None, fillfactor=None, **options) Creates a `GiST index - <https://www.postgresql.org/docs/current/static/gist.html>`_. These indexes - are automatically created on spatial fields with :attr:`spatial_index=True + <https://www.postgresql.org/docs/current/gist.html>`_. These indexes are + automatically created on spatial fields with :attr:`spatial_index=True <django.contrib.gis.db.models.BaseSpatialField.spatial_index>`. They're also useful on other types, such as :class:`~django.contrib.postgres.fields.HStoreField` or the :ref:`range fields <range-fields>`. To use this index on data types not in the built-in `gist operator classes - <https://www.postgresql.org/docs/current/static/gist-builtin-opclasses.html>`_, + <https://www.postgresql.org/docs/current/gist-builtin-opclasses.html>`_, you need to activate the `btree_gist extension - <https://www.postgresql.org/docs/current/static/btree-gist.html>`_ on - PostgreSQL. You can install it using the + <https://www.postgresql.org/docs/current/btree-gist.html>`_ on PostgreSQL. + You can install it using the :class:`~django.contrib.postgres.operations.BtreeGistExtension` migration operation. @@ -93,8 +92,8 @@ available from the ``django.contrib.postgres.indexes`` module. Provide an integer value from 10 to 100 to the fillfactor_ parameter to tune how packed the index pages will be. PostgreSQL's default is 90. - .. _buffering build: https://www.postgresql.org/docs/current/static/gist-implementation.html#GIST-BUFFERING-BUILD - .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS + .. _buffering build: https://www.postgresql.org/docs/current/gist-implementation.html#GIST-BUFFERING-BUILD + .. _fillfactor: https://www.postgresql.org/docs/current/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS ``HashIndex`` ============= @@ -113,7 +112,7 @@ available from the ``django.contrib.postgres.indexes`` module. Hash indexes have been available in PostgreSQL for a long time, but they suffer from a number of data integrity issues in older versions. - .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS + .. _fillfactor: https://www.postgresql.org/docs/current/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS ``SpGistIndex`` =============== @@ -123,9 +122,9 @@ available from the ``django.contrib.postgres.indexes`` module. .. versionadded:: 2.2 Creates an `SP-GiST index - <https://www.postgresql.org/docs/current/static/spgist.html>`_. + <https://www.postgresql.org/docs/current/spgist.html>`_. Provide an integer value from 10 to 100 to the fillfactor_ parameter to tune how packed the index pages will be. PostgreSQL's default is 90. - .. _fillfactor: https://www.postgresql.org/docs/current/static/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS + .. _fillfactor: https://www.postgresql.org/docs/current/sql-createindex.html#SQL-CREATEINDEX-STORAGE-PARAMETERS diff --git a/docs/ref/contrib/postgres/lookups.txt b/docs/ref/contrib/postgres/lookups.txt index 02ba6716de..ab7a954bf2 100644 --- a/docs/ref/contrib/postgres/lookups.txt +++ b/docs/ref/contrib/postgres/lookups.txt @@ -15,8 +15,8 @@ similarity threshold. To use it, add ``'django.contrib.postgres'`` in your :setting:`INSTALLED_APPS` and activate the `pg_trgm extension -<https://www.postgresql.org/docs/current/static/pgtrgm.html>`_ on -PostgreSQL. You can install the extension using the +<https://www.postgresql.org/docs/current/pgtrgm.html>`_ on PostgreSQL. You can +install the extension using the :class:`~django.contrib.postgres.operations.TrigramExtension` migration operation. @@ -41,7 +41,7 @@ the `unaccent extension on PostgreSQL`_. The :class:`~django.contrib.postgres.operations.UnaccentExtension` migration operation is available if you want to perform this activation using migrations). -.. _unaccent extension on PostgreSQL: https://www.postgresql.org/docs/current/static/unaccent.html +.. _unaccent extension on PostgreSQL: https://www.postgresql.org/docs/current/unaccent.html The ``unaccent`` lookup can be used on :class:`~django.db.models.CharField` and :class:`~django.db.models.TextField`:: diff --git a/docs/ref/contrib/postgres/search.txt b/docs/ref/contrib/postgres/search.txt index 1ae6233abe..d3fd505958 100644 --- a/docs/ref/contrib/postgres/search.txt +++ b/docs/ref/contrib/postgres/search.txt @@ -4,7 +4,7 @@ Full text search The database functions in the ``django.contrib.postgres.search`` module ease the use of PostgreSQL's `full text search engine -<https://www.postgresql.org/docs/current/static/textsearch.html>`_. +<https://www.postgresql.org/docs/current/textsearch.html>`_. For the examples in this document, we'll use the models defined in :doc:`/topics/db/queries`. @@ -83,7 +83,7 @@ as a single phrase. If ``search_type`` is ``'raw'``, then you can provide a formatted search query with terms and operators. Read PostgreSQL's `Full Text Search docs`_ to learn about differences and syntax. Examples: -.. _Full Text Search docs: https://www.postgresql.org/docs/current/static/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES +.. _Full Text Search docs: https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES >>> from django.contrib.postgres.search import SearchQuery >>> SearchQuery('red tomato') # two keywords @@ -184,7 +184,7 @@ In the event that all the fields you're querying on are contained within one particular model, you can create a functional index which matches the search vector you wish to use. The PostgreSQL documentation has details on `creating indexes for full text search -<https://www.postgresql.org/docs/current/static/textsearch-tables.html#TEXTSEARCH-TABLES-INDEX>`_. +<https://www.postgresql.org/docs/current/textsearch-tables.html#TEXTSEARCH-TABLES-INDEX>`_. ``SearchVectorField`` --------------------- @@ -200,7 +200,7 @@ if it were an annotated ``SearchVector``:: >>> Entry.objects.filter(search_vector='cheese') [<Entry: Cheese on Toast recipes>, <Entry: Pizza recipes>] -.. _PostgreSQL documentation: https://www.postgresql.org/docs/current/static/textsearch-features.html#TEXTSEARCH-UPDATE-TRIGGERS +.. _PostgreSQL documentation: https://www.postgresql.org/docs/current/textsearch-features.html#TEXTSEARCH-UPDATE-TRIGGERS Trigram similarity ================== @@ -210,8 +210,8 @@ three consecutive characters. In addition to the :lookup:`trigram_similar` lookup, you can use a couple of other expressions. To use them, you need to activate the `pg_trgm extension -<https://www.postgresql.org/docs/current/static/pgtrgm.html>`_ on -PostgreSQL. You can install it using the +<https://www.postgresql.org/docs/current/pgtrgm.html>`_ on PostgreSQL. You can +install it using the :class:`~django.contrib.postgres.operations.TrigramExtension` migration operation. |