Update documentation for mysql_db notes (#50444)

* Simplify the requirement section to avoid duplicating info already in mysql_document_fragment.
* Package installation section simplified, mentioned RHEL; a typo fix in "than".
* added dnf for Fedora
This commit is contained in:
Richlv 2019-01-04 05:10:57 +02:00 committed by Abhijeet Kasurde
parent 27c7d5bb01
commit 73ffe683b2
2 changed files with 6 additions and 6 deletions

View file

@ -67,8 +67,7 @@ requirements:
- mysql (command line binary) - mysql (command line binary)
- mysqldump (command line binary) - mysqldump (command line binary)
notes: notes:
- Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) package on the remote host, - Requires the mysql and mysqldump binaries on the remote host.
as well as mysql and mysqldump binaries.
- This module is B(not idempotent) when I(state) is C(import), and will import the dump file each time if run more than once. - This module is B(not idempotent) when I(state) is C(import), and will import the dump file each time if run more than once.
extends_documentation_fragment: mysql extends_documentation_fragment: mysql
''' '''

View file

@ -34,7 +34,7 @@ options:
default: localhost default: localhost
login_port: login_port:
description: description:
- Port of the MySQL server. Requires I(login_host) be defined as other then localhost if login_port is used. - Port of the MySQL server. Requires I(login_host) be defined as other than localhost if login_port is used.
default: 3306 default: 3306
login_unix_socket: login_unix_socket:
description: description:
@ -66,9 +66,10 @@ requirements:
- PyMySQL (Python 2.7 and Python 3.X), or - PyMySQL (Python 2.7 and Python 3.X), or
- MySQLdb (Python 2.x) - MySQLdb (Python 2.x)
notes: notes:
- Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) Python package on the remote host. - Requires the PyMySQL (Python 2.7 and Python 3.X) or MySQL-python (Python 2.X) package on the remote host.
For Ubuntu, this is as easy as apt-get install python-pymysql. (See M(apt).) For CentOS/Fedora, this The Python package may be installed with apt-get install python-pymysql (Ubuntu; see M(apt)) or
is as easy as yum install python2-PyMySQL. (See M(yum).) yum install python2-PyMySQL (RHEL/CentOS/Fedora; see M(yum)). You can also use dnf install python2-PyMySQL
for newer versions of Fedora; see M(dnf).
- Both C(login_password) and C(login_user) are required when you are - Both C(login_password) and C(login_user) are required when you are
passing credentials. If none are present, the module will attempt to read passing credentials. If none are present, the module will attempt to read
the credentials from C(~/.my.cnf), and finally fall back to using the MySQL the credentials from C(~/.my.cnf), and finally fall back to using the MySQL