added connect_params to allow any additional parameters that libpg understands

changelogs/fragments/329-postgresql_add_connect_params_field.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- postgresql_* - Add ``connect_params`` parameter dict to allow any additional libpg connection parameters.

plugins/doc_fragments/postgres.py

@@ -48,6 +48,10 @@ class ModuleDocFragment(object):
       - If the file exists, the server's certificate will be verified to be signed by one of these authorities.
     type: str
     aliases: [ ssl_rootcert ]
+  connect_params:
+    description:
+      - Any additional parameters to be passed to libpg as kwargs.
+    type: dict
 notes:
 - The default authentication assumes that you are either logging in as or sudo'ing to the C(postgres) account on the host.
 - To avoid "Peer authentication failed for user postgres" error,

plugins/module_utils/postgres.py

@@ -44,6 +44,7 @@ def postgres_common_argument_spec():
         port=dict(type='int', default=5432, aliases=['login_port']),
         ssl_mode=dict(default='prefer', choices=['allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']),
         ca_cert=dict(aliases=['ssl_rootcert']),
+        connect_params=dict(default={}, type='dict'),
     )
 
 
@@ -185,7 +186,7 @@ def get_conn_params(module, params_dict, warn_db_default=True):
         "login_password": "password",
         "port": "port",
         "ssl_mode": "sslmode",
-        "ca_cert": "sslrootcert"
+        "ca_cert": "sslrootcert",
     }
 
     # Might be different in the modules:
@@ -223,6 +224,10 @@ def get_conn_params(module, params_dict, warn_db_default=True):
     if is_localhost and params_dict["login_unix_socket"] != "":
         kw["host"] = params_dict["login_unix_socket"]
 
+    # If connect_params is specified, merge it together
+    if params_dict.get("connect_params"):
+        kw.update(params_dict["connect_params"])
+
     return kw
 
 

plugins/modules/postgresql_query.py

@@ -155,6 +155,17 @@
     db: test_db
     query: INSERT INTO test_table (id, story) VALUES (2, 'my_long_story')
 
+- name: Use connect_params to add any additional connection parameters that libpg supports
+  community.postgresql.postgresql_query:
+    connect_params:
+      target_session_attrs: "read-write"
+      connect_timeout: "10"
+    login_host: "host1,host2"
+    login_user: "test"
+    login_password: "test1234"
+    db: 'test'
+    query: 'insert into test (test) values (now())'
+
 
 # WARNING: The path_to_script and as_single_query options have been deprecated
 # and will be removed in community.postgresql 3.0.0, please

tests/unit/plugins/module_utils/test_postgres.py

@@ -61,6 +61,7 @@ def test_postgres_common_argument_spec(self):
                 choices=['allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']
             ),
             ca_cert=dict(aliases=['ssl_rootcert']),
+            connect_params=dict(default={}, type='dict'),
         )
         assert pg.postgres_common_argument_spec() == expected_dict
 
@@ -112,7 +113,7 @@ def __init__(self):
             self.extensions = Extensions()
 
         def connect(self, host=None, port=None, user=None,
-                    password=None, sslmode=None, sslrootcert=None):
+                    password=None, sslmode=None, sslrootcert=None, connect_params=None):
             if user == 'Exception':
                 raise Exception()
 
@@ -189,7 +190,14 @@ def m_ansible_module():
     """Return an object of dummy AnsibleModule class."""
     class DummyAnsibleModule():
         def __init__(self):
-            self.params = pg.postgres_common_argument_spec()
+
+            # take default params from argument spec
+            spec = pg.postgres_common_argument_spec()
+            params = dict()
+            for k in spec.keys():
+                params[k] = spec[k].get('default')
+
+            self.params = params
             self.err_msg = ''
             self.warn_msg = ''