Skip to content

Commit 6f785f7

Browse files
committed
documentation: add description of conn:close() and pool:close() methods
1 parent 6e813c2 commit 6f785f7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,14 @@ Update the connection authentication settings.
200200

201201
Throws an error on failure.
202202

203+
### `conn:close()`
204+
205+
Close the individual connection or return it to a pool.
206+
207+
Throws an error on failure.
208+
209+
*Returns*: `true`
210+
203211
### `pool = mysql.pool_create(opts)`
204212

205213
Create a connection pool with count of size established connections.
@@ -247,6 +255,12 @@ Return a connection to connection pool.
247255

248256
- `conn` - a connection
249257

258+
### `pool:close()`
259+
260+
Close all connections in pool.
261+
262+
*Returns*: `true`
263+
250264
## Comments
251265

252266
All calls to connections api will be serialized, so it should to be safe to

0 commit comments

Comments
 (0)