#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright (c) 2021, Rainer Leber # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later from __future__ import (absolute_import, division, print_function) __metaclass__ = type DOCUMENTATION = r''' --- module: hana_query short_description: Execute SQL on HANA version_added: 3.2.0 description: This module executes SQL statements on HANA with hdbsql. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: none diff_mode: support: none options: sid: description: The system ID. type: str required: true instance: description: The instance number. type: str required: true user: description: A dedicated username. The user could be also in hdbuserstore. Defaults to C(SYSTEM). type: str default: SYSTEM userstore: description: If C(true) the user must be in hdbuserstore. type: bool default: false version_added: 3.5.0 password: description: - The password to connect to the database. - "B(Note:) Since the passwords have to be passed as command line arguments, I(userstore=true) should be used whenever possible, as command line arguments can be seen by other users on the same machine." type: str autocommit: description: Autocommit the statement. type: bool default: true host: description: The Host IP address. The port can be defined as well. type: str database: description: Define the database on which to connect. type: str encrypted: description: Use encrypted connection. Defaults to C(false). type: bool default: false filepath: description: - One or more files each containing one SQL query to run. - Must be a string or list containing strings. type: list elements: path query: description: - SQL query to run. - Must be a string or list containing strings. Please note that if you supply a string, it will be split by commas (C(,)) to a list. It is better to supply a one-element list instead to avoid mangled input. type: list elements: str author: - Rainer Leber (@rainerleber) ''' EXAMPLES = r''' - name: Simple select query community.general.hana_query: sid: "hdb" instance: "01" password: "Test123" query: "select user_name from users" - name: Run several queries community.general.hana_query: sid: "hdb" instance: "01" password: "Test123" query: - "select user_name from users;" - select * from SYSTEM; host: "localhost" autocommit: false - name: Run several queries from file community.general.hana_query: sid: "hdb" instance: "01" password: "Test123" filepath: - /tmp/HANA_CPU_UtilizationPerCore_2.00.020+.txt - /tmp/HANA.txt host: "localhost" - name: Run several queries from user store community.general.hana_query: sid: "hdb" instance: "01" user: hdbstoreuser userstore: true query: - "select user_name from users;" - select * from users; autocommit: false ''' RETURN = r''' query_result: description: List containing results of all queries executed (one sublist for every query). returned: on success type: list elements: list sample: [[{"Column": "Value1"}, {"Column": "Value2"}], [{"Column": "Value1"}, {"Column": "Value2"}]] ''' import csv from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.six import StringIO from ansible.module_utils.common.text.converters import to_native def csv_to_list(rawcsv): reader_raw = csv.DictReader(StringIO(rawcsv)) reader = [dict((k, v.strip()) for k, v in row.items()) for row in reader_raw] return list(reader) def main(): module = AnsibleModule( argument_spec=dict( sid=dict(type='str', required=True), instance=dict(type='str', required=True), encrypted=dict(type='bool', default=False), host=dict(type='str', required=False), user=dict(type='str', default="SYSTEM"), userstore=dict(type='bool', default=False), password=dict(type='str', no_log=True), database=dict(type='str', required=False), query=dict(type='list', elements='str', required=False), filepath=dict(type='list', elements='path', required=False), autocommit=dict(type='bool', default=True), ), required_one_of=[('query', 'filepath')], required_if=[('userstore', False, ['password'])], supports_check_mode=False, ) rc, out, err, out_raw = [0, [], "", ""] params = module.params sid = (params['sid']).upper() instance = params['instance'] user = params['user'] userstore = params['userstore'] password = params['password'] autocommit = params['autocommit'] host = params['host'] database = params['database'] encrypted = params['encrypted'] filepath = params['filepath'] query = params['query'] bin_path = "/usr/sap/{sid}/HDB{instance}/exe/hdbsql".format(sid=sid, instance=instance) try: command = [module.get_bin_path(bin_path, required=True)] except Exception as e: module.fail_json(msg='Failed to find hdbsql at the expected path "{0}". Please check SID and instance number: "{1}"'.format(bin_path, to_native(e))) if encrypted is True: command.extend(['-attemptencrypt']) if autocommit is False: command.extend(['-z']) if host is not None: command.extend(['-n', host]) if database is not None: command.extend(['-d', database]) # -x Suppresses additional output, such as the number of selected rows in a result set. if userstore: command.extend(['-x', '-U', user]) else: command.extend(['-x', '-i', instance, '-u', user, '-p', password]) if filepath is not None: command.extend(['-I']) for p in filepath: # makes a command like hdbsql -i 01 -u SYSTEM -p secret123# -I /tmp/HANA_CPU_UtilizationPerCore_2.00.020+.txt, # iterates through files and append the output to var out. query_command = command + [p] (rc, out_raw, err) = module.run_command(query_command) out.append(csv_to_list(out_raw)) if query is not None: for q in query: # makes a command like hdbsql -i 01 -u SYSTEM -p secret123# "select user_name from users", # iterates through multiple commands and append the output to var out. query_command = command + [q] (rc, out_raw, err) = module.run_command(query_command) out.append(csv_to_list(out_raw)) changed = True module.exit_json(changed=changed, rc=rc, query_result=out, stderr=err) if __name__ == '__main__': main()