From f0b4fa46775cdc52ebcdd2b323918291135eb3e7 Mon Sep 17 00:00:00 2001 From: Laurence Isla Date: Thu, 5 Oct 2023 13:56:13 -0500 Subject: [PATCH 1/3] Version not set when invalid URI or key/value format --- docs/references/admin.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/references/admin.rst b/docs/references/admin.rst index 34ba883ba..267aefefe 100644 --- a/docs/references/admin.rst +++ b/docs/references/admin.rst @@ -108,7 +108,8 @@ When debugging a problem it's important to verify the running PostgREST version. .. note:: - The server sets the `fallback_application_name `_ for this query to work. To override the value set ``application_name`` on the connection string. + - The server sets the `fallback_application_name `_ to the connection URI for this query to work. To override the value set ``application_name`` on the connection string. + - The version will not be set if the connection string is in `keyword/value format `_ or if it contains certain unescaped special characters. - The ``stderr`` logs also contain the version, as noted on :ref:`pgrst_logging`. From 0d2476b04c3a722a4b15ece07edce1a187b5a9ac Mon Sep 17 00:00:00 2001 From: Laurence Isla Date: Thu, 5 Oct 2023 14:44:07 -0500 Subject: [PATCH 2/3] Clarify valid string Co-authored-by: Steve Chavez --- docs/references/admin.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/references/admin.rst b/docs/references/admin.rst index 267aefefe..82e59e683 100644 --- a/docs/references/admin.rst +++ b/docs/references/admin.rst @@ -109,7 +109,8 @@ When debugging a problem it's important to verify the running PostgREST version. .. note:: - The server sets the `fallback_application_name `_ to the connection URI for this query to work. To override the value set ``application_name`` on the connection string. - - The version will not be set if the connection string is in `keyword/value format `_ or if it contains certain unescaped special characters. + - The version will only be set if it's a valid URI (`RFC 3986 `_). This means any special characters must be urlencoded. + - The version will not be set if the connection string is in `keyword/value format `_. - The ``stderr`` logs also contain the version, as noted on :ref:`pgrst_logging`. From d11301c697e7cd8a44dc039ece85bc9dfa58c0fa Mon Sep 17 00:00:00 2001 From: Laurence Isla Date: Thu, 5 Oct 2023 14:44:51 -0500 Subject: [PATCH 3/3] Fix link and modify important note --- docs/references/admin.rst | 2 +- docs/references/api/tables_views.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/references/admin.rst b/docs/references/admin.rst index 82e59e683..e54d542a9 100644 --- a/docs/references/admin.rst +++ b/docs/references/admin.rst @@ -106,7 +106,7 @@ When debugging a problem it's important to verify the running PostgREST version. ------------------------------ PostgREST 11.1.0 -.. note:: +.. important:: - The server sets the `fallback_application_name `_ to the connection URI for this query to work. To override the value set ``application_name`` on the connection string. - The version will only be set if it's a valid URI (`RFC 3986 `_). This means any special characters must be urlencoded. diff --git a/docs/references/api/tables_views.rst b/docs/references/api/tables_views.rst index 518a58e2e..fd46d856c 100644 --- a/docs/references/api/tables_views.rst +++ b/docs/references/api/tables_views.rst @@ -196,7 +196,7 @@ Pattern Matching The pattern-matching operators (:code:`like`, :code:`ilike`, :code:`match`, :code:`imatch`) exist to support filtering data using patterns instead of concrete strings, as described in the `PostgreSQL docs `__. -To ensure best performance on larger data sets, an `appropriate index `__ should be used and even then, it depends on the pattern value and actual data statistics whether an existing index will be used by the query planner or not. +To ensure best performance on larger data sets, an `appropriate index `__ should be used and even then, it depends on the pattern value and actual data statistics whether an existing index will be used by the query planner or not. .. _fts: