Doc: Improve description of connection strings with Percent-encoding
authorMichael Paquier
Sun, 19 Jan 2020 09:55:51 +0000 (18:55 +0900)
committerMichael Paquier
Sun, 19 Jan 2020 09:55:51 +0000 (18:55 +0900)
Clarify the description related to the use of characters which can be
encoded, and add an example.

Author: Jobin Augustine
Reviewed-by: Peter Eisentraut, Alvaro Herrera, Heikki Linnakangas,
Michael Paquier, Alex Shulgin
Discussion: https://postgr.es/m/CANaTPsrYgSgE2fuj3=4x=Jmx1c+NgkEDzftNknZbrMuqL+aBhQ@mail.gmail.com

doc/src/sgml/libpq.sgml

index 64cff49c4d7231baeb6d2102ca9a1cf56d5440af..fcbf7fafbd995afe10c6ebf6cebf70325e7714c5 100644 (file)
@@ -925,10 +925,15 @@ postgresql:///mydb?host=localhost&port=5433
    
 
    
-    Percent-encoding may be used to include symbols with special meaning in any
-    of the URI parts, e.g. replace = with
-    %3D.
-
+    Connection URI needs to be encoded with 
+    Percent-encoding 
+    if it includes symbols with special meaning in any of its parts. 
+    Here is an example where equal sign (=) is replaced
+    with %3D and whitespace character with
+    %20:
+
+postgresql://user@localhost:5433/mydb?options=-c%20synchronous_commit%3Doff
+