Skip to content

Commit 51200f7

Browse files
committed
doc: markdown formatting fixes.
1 parent d010514 commit 51200f7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,22 +185,31 @@ Attempts to connect to the remote MySQL server.
185185
The `options` argument is a Lua table holding the following keys:
186186

187187
* `host`
188+
188189
the host name for the MySQL server.
189190
* `port`
191+
190192
the port that the MySQL server is listening on. Default to 3306.
191193
* `path`
194+
192195
the path of the unix socket file listened by the MySQL server.
193196
* `database`
197+
194198
the MySQL database name.
195199
* `user`
200+
196201
MySQL account name for login.
197202
* `password`
203+
198204
MySQL account password for login (in clear text).
199205
* `max_packet_size`
206+
200207
the upper limit for the reply packets sent from the MySQL server (default to 1MB).
201208
* `pool`
209+
202210
the name for the MySQL connection pool. if omitted, an ambiguous pool name will be generated automatically with the string template `user:database:host:port` or `user:database:path`. (this option was first introduced in `v0.08`.)
203211
* `compact_arrays`
212+
204213
when this option is set to true, then the [query](#query) and [read_result](#read_result) methods will return the array-of-arrays structure for the resultset, rather than the default array-of-hashes structure.
205214

206215
Before actually resolving the host name and connecting to the remote backend, this method will always look up the connection pool for matched idle connections created by previous calls of this method.

0 commit comments

Comments
 (0)