ansible-collections/community.mysql
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.mysql.git synced 2025-08-27 08:21:46 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update config file notes as discussed

Browse source
This commit is contained in:
Chris Croome 2022-06-14 19:12:21 +01:00
commit f96de6a76a
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
plugins/doc_fragments/mysql.py
View file

@ -44,6 +44,9 @@ options:
config_file: config_file:
description: description:
- Specify a config file from which user and password are to be read. - Specify a config file from which user and password are to be read.
- The default config file, C(~/.my.cnf), if it exists, will be read, even if I(config_file) is not specified.
- The default config file, C(~/.my.cnf), if it exists, must contain a C([client]) section as a MySQL connector requirement.
- To prevent the default config file from being read, set I(config_file) to be an empty string.
type: path type: path
default: '~/.my.cnf' default: '~/.my.cnf'
ca_cert: ca_cert:
@ -98,9 +101,7 @@ notes:
- Alternatively, you can use the mysqlclient library instead of MySQL-python (MySQLdb) - Alternatively, you can use the mysqlclient library instead of MySQL-python (MySQLdb)
which supports both Python 2.X and Python >=3.5. which supports both Python 2.X and Python >=3.5.
See U(https://pypi.org/project/mysqlclient/) how to install it. See U(https://pypi.org/project/mysqlclient/) how to install it.
- The config file, C(~/.my.cnf), if it exists, must contain a C([client]) section as a MySQL connector requirement. - If credentials from the config file (for example, C(/root/.my.cnf)) are not needed to connect to a database server, but
- The default config file, C(~/.my.cnf) will be read, if it exists, even if I(config_file) is not specified. the file exists and does not contain a C([client]) section, before any other valid directives, it will be read and this
- To prevent the default config file from being read, set I(config_file) to be an empty string. will cause the connection to fail, to prevent this set it to an empty string, (for example C(config_file: '')).
- If credentials from the config file (for example, C(/root/.my.cnf)) are not needed to connect to a database server but
the file exists and does not contain a C([client]) section, it will be read and will cause the connection to fail.
''' '''