Update docs for MySQL

MySQL supports a few non-standard options. Document them.
This commit is contained in:
mark_story 2013-07-19 23:01:16 -04:00
parent 8913f4fc08
commit 2d2721d2d9

View file

@ -130,6 +130,15 @@ class Mysql extends DboSource {
/**
* Connects to the database using options in the given configuration array.
*
* MySQL supports a few additional options that other drivers do not:
*
* - `unix_socket` Set to the path of the MySQL sock file. Can be used in place
* of host + port.
* - `ssl_key` SSL key file for connecting via SSL. Must be combined with `ssl_cert`.
* - `ssl_cert` The SSL certificate to use when connecting via SSL. Must be
* combined with `ssl_key`.
* - `ssl_ca` The certificate authority for SSL connections.
*
* @return boolean True if the database could be connected, else false
* @throws MissingConnectionException
*/