Document mysql_(user,db) login_unix_socket option

mysql_user and mysql_db both take a login_unix_socket option.

This patch adds docs that describe how to use it.
This commit is contained in:
Lorin Hochstein 2013-03-15 11:40:54 -04:00
parent fc8d9377d5
commit 1de91d2181
2 changed files with 12 additions and 0 deletions

View file

@ -47,6 +47,11 @@ options:
- Host running the database - Host running the database
required: false required: false
default: localhost default: localhost
login_unix_socket:
description:
- The path to a Unix domain socket for local connections
required: false
default: null
state: state:
description: description:
- The database state - The database state

View file

@ -56,6 +56,11 @@ options:
- Host running the database - Host running the database
required: false required: false
default: localhost default: localhost
login_unix_socket:
description:
- The path to a Unix domain socket for local connections
required: false
default: null
priv: priv:
description: description:
- "MySQL privileges string in the format: C(db.table:priv1,priv2)" - "MySQL privileges string in the format: C(db.table:priv1,priv2)"
@ -74,6 +79,8 @@ examples:
description: Ensure no user named 'sally' exists, also passing in the auth credentials. description: Ensure no user named 'sally' exists, also passing in the auth credentials.
- code: mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL - code: mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
description: Example privileges string format description: Example privileges string format
- code: "mysql_user: name=root password=abc123 login_unix_socket=/var/run/mysqld/mysqld.sock"
description: Example using login_unix_socket to connect to server
notes: notes:
- Requires the MySQLdb Python package on the remote host. For Ubuntu, this - Requires the MySQLdb Python package on the remote host. For Ubuntu, this
is as easy as apt-get install python-mysqldb. is as easy as apt-get install python-mysqldb.