community.sap_libs.sap_hdbsql module – Ansible Module to execute SQL on SAP HANA
Note
This module is part of the community.sap_libs collection (version 1.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.sap_libs
.
To use it in a playbook, specify: community.sap_libs.sap_hdbsql
.
New in community.sap_libs 1.0.0
Synopsis
This module executes SQL statements on HANA with hdbsql.
Parameters
Parameter |
Comments |
---|---|
Autocommit the statement. Choices:
|
|
The path to the hdbsql binary. |
|
Define the database on which to connect. |
|
Use encrypted connection. Choices:
|
|
One or more files each containing one SQL query to run. Must be a string or list containing strings. |
|
The Host IP address. The port can be defined as well. |
|
The instance number. |
|
The password to connect to the database. Note: Since the passwords have to be passed as command line arguments, userstore=true should be used whenever possible, as command line arguments can be seen by other users on the same machine. |
|
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 ( |
|
The system ID. |
|
A dedicated username. The user could be also in hdbuserstore. Default: |
|
If Choices:
|
Notes
Note
Does not support
check_mode
. Always reports that the state has changed even if no changes have been made.
Examples
- name: Simple select query
community.sap_libs.sap_hdbsql:
sid: "hdb"
instance: "01"
password: "Test123"
query: select user_name from users
- name: RUN select query with host port
community.sap_libs.sap_hdbsql:
sid: "hdb"
instance: "01"
password: "Test123"
host: "10.10.2.4:30001"
query: select user_name from users
- name: Run several queries
community.sap_libs.sap_hdbsql:
sid: "hdb"
instance: "01"
password: "Test123"
query:
- select user_name from users
- select * from SYSTEM
host: "localhost"
autocommit: False
- name: Run several queries with path
community.sap_libs.sap_hdbsql:
bin_path: "/usr/sap/HDB/HDB01/exe/hdbsql"
instance: "01"
password: "Test123"
query:
- select user_name from users
- select * from users
host: "localhost"
autocommit: False
- name: Run several queries from file
community.sap_libs.sap_hdbsql:
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.sap_libs.sap_hdbsql:
sid: "hdb"
instance: "01"
user: hdbstoreuser
userstore: true
query:
- select user_name from users
- select * from users
autocommit: False
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List containing results of all queries executed (one sublist for every query). Returned: on success Sample: |