Skip to content

Commit 1e69da2

Browse files
committed
Section about debugging and reporting problems
1 parent d3ce47c commit 1e69da2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Readme.md

+18
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,24 @@ var query = connection.query('...'):
357357
query.typeCast = false;
358358
```
359359

360+
## Debugging and Reporting Problems
361+
362+
If you are running into problems, one thing that may help is enabling the
363+
`debug` mode for the connection:
364+
365+
```js
366+
var connection = mysql.createConnection({debug: true});
367+
```
368+
369+
This will print all incoming and outgoing packets on stdout.
370+
371+
If that does not help, feel free to open a GitHub issue. A good GitHub issue
372+
will have:
373+
374+
* The minimal amount of code required to reproduce the problem (if possible)
375+
* As much debugging output and information about your environment (mysql
376+
version, node version, os, etc.) as you can gather.
377+
360378
## FAQ
361379

362380
I have yet to write this, but it will include:

0 commit comments

Comments
 (0)