Doc: describe the "options" allowed in an ECPG connection target string.
authorTom Lane
Sat, 31 Aug 2019 18:05:32 +0000 (14:05 -0400)
committerTom Lane
Sat, 31 Aug 2019 18:05:32 +0000 (14:05 -0400)
These have been there a long time, but their format was never explained
in the docs.  Per complaint from Yusuke Egashira.

Discussion: https://postgr.es/m/848B1649C8A6274AA527C4472CA11EDD5FC70CBE@G01JPEXMBYT02

doc/src/sgml/ecpg.sgml

index a7d90047edeab0c66b527bae62fca5e476a55ffe..95cabb5d26f3d22fe73396b97dc48a25879c1dde 100644 (file)
@@ -177,6 +177,19 @@ EXEC SQL CONNECT TO target AS 
    SQL string literal, or a reference to a character variable.
   
 
+  
+   If the connection target includes any options,
+   those consist of
+   keyword=value
+   specifications separated by ampersands (&).
+   The allowed key words are the same ones recognized
+   by libpq (see
+   ).  Spaces are ignored before
+   any keyword or value,
+   though not within or after one.  Note that there is no way to
+   write & within a value.
+  
+
   
    The connection-name is used to handle
    multiple connections in one program.  It can be omitted if a
@@ -191,7 +204,7 @@ EXEC SQL CONNECT TO target AS 
    secure schema usage pattern,
    begin each session by removing publicly-writable schemas
    from search_path.  For example,
-   add options=-csearch_path=
+   add options=-c search_path=
    to options, or
    issue EXEC SQL SELECT pg_catalog.set_config('search_path', '',
    false); after connecting.  This consideration is not specific to