postgresql_query: a list of queries can be passed (#394)

* postgresql_query: a list of queries can be passed

* forgot to gitadd the fragment

* fix typo

Author: Andersson007

changelogs/fragments/0-postgresql_query.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- postgresql_query - a list of queries can be passed as the ``query`` argument's value, the results will be stored in the ``query_all_results`` return value (is not deprecated anymore, as well as ``query_list``) (https://github.com/ansible-collections/community.postgresql/issues/312).

plugins/modules/postgresql_query.py

@@ -23,9 +23,9 @@
 options:
   query:
     description:
-    - SQL query to run. Variables can be escaped with psycopg2 syntax
+    - SQL query string or list of queries to run. Variables can be escaped with psycopg2 syntax
       U(http://initd.org/psycopg/docs/usage.html).
-    type: str
+    type: raw
   positional_args:
     description:
     - List of values to be passed as positional arguments to the query.
@@ -132,6 +132,14 @@
     db: acme
     query: SELECT version()
 
+# The result of each query will be stored in query_all_results return value
+- name: Run several queries against acme db
+  community.postgresql.postgresql_query:
+    db: acme
+    query:
+    - SELECT version()
+    - SELECT id FROM accounts
+
 - name: Select query to db acme with positional arguments and non-default credentials
   community.postgresql.postgresql_query:
     db: acme
@@ -268,8 +276,6 @@
     sample: [{"Column": "Value1"},{"Column": "Value2"}]
 query_list:
     description:
-    - This return value has been B(deprecated) and will be removed in
-      community.postgresql 3.0.0.
     - List of executed queries.
       Useful when reading several queries from a file.
     returned: always
@@ -278,10 +284,8 @@
     sample: ['SELECT * FROM foo', 'SELECT * FROM bar']
 query_all_results:
     description:
-    - This return value has been B(deprecated) and will be removed in
-      community.postgresql 3.0.0.
     - List containing results of all queries executed (one sublist for every query).
-      Useful when reading several queries from a file.
+      Useful when running a list of queries.
     returned: always
     type: list
     elements: list
@@ -340,7 +344,7 @@ def insane_query(string):
 def main():
     argument_spec = postgres_common_argument_spec()
     argument_spec.update(
-        query=dict(type='str'),
+        query=dict(type='raw'),
         db=dict(type='str', aliases=['login_db']),
         positional_args=dict(type='list', elements='raw'),
         named_args=dict(type='dict'),
@@ -370,6 +374,9 @@ def main():
     search_path = module.params["search_path"]
     as_single_query = module.params["as_single_query"]
 
+    if query and not isinstance(query, (str, list)):
+        module.fail_json(msg="query argument must be of type string or list")
+
     if not trust_input:
         # Check input for potentially dangerous elements:
         check_input(module, session_role)
@@ -411,7 +418,10 @@ def main():
         except Exception as e:
             module.fail_json(msg="Cannot read file '%s' : %s" % (path_to_script, to_native(e)))
     else:
-        query_list.append(query)
+        if isinstance(query, str):
+            query_list.append(query)
+        else:  # if it's a list
+            query_list = query
 
     # Ensure psycopg2 libraries are available before connecting to DB:
     ensure_required_libs(module)

tests/integration/targets/postgresql_query/tasks/postgresql_query_initial.yml

@@ -583,3 +583,22 @@
       - result.rowcount == 1
       - result.query_result[0]["make_interval"] == "0:00:03"
     when: postgres_version_resp.stdout is version('10', '>=')
+
+  ##############################################################################
+  # Issue https://github.com/ansible-collections/community.postgresql/issues/312
+  - name: Run several queries
+    become_user: '{{ pg_user }}'
+    become: true
+    postgresql_query:
+      <<: *pg_parameters
+      query:
+      - SELECT 1
+      - SELECT 1
+      - SELECT 1
+    register: result
+
+  - assert:
+      that:
+      - result.rowcount == 3
+      - result.query_result == [{"?column?": 1}]
+      - 'result.query_all_results == [[{"?column?": 1}], [{"?column?": 1}], [{"?column?": 1}]]'