How do you close connections????

[davidnewcomb]

On page node-mysql2/docs there isn't a single example of how to close the connection after you have used it!
Pooled connections get a brief mention.

On connections/create-connection no mention of closing connections again. However, on page connections/create-pool, each connection example has some code and then a warning to say, "don't forget to add some of the bits we missed out of our example". Seriously? And connections/createPoolCluster doubles down on examples and warnings.

I seem to remember seeing on one page something about .end() there was no explanation, it was just stuffed into one of the testing examples and never mentioned again. I can't even find the page now!

I was so confused by all this that I had to Google it. The first result in the rankings was a StackOverflow article from 7 years ago where people are literally having to guess what the answer is.

Please can you add the "obvious" bits to the documentation around closing connections. Including any gotchas about running in production or development modes for the various stragegies (for example) would be really helpful.

[wellwelwel]

Hi, @davidnewcomb 🙋🏻‍♂️

This PR intends to solve this:

• Added close connections in quickstart. #2725

---

For now, there are some examples closing the connection methods in Testing sections:

• createConnection
• createPool
• createPoolCluster

But I also agree that this should be better located in the documentation.

---

Related:

• Add connection.end() call to quickstart documentation #2543