deadpool icon indicating copy to clipboard operation
deadpool copied to clipboard

PostgreSQL: better documentation for statement caching

Open jaskij opened this issue 1 year ago • 1 comments

As is, the only explanation for how deadpool_postgres handles caching prepared statements I'm aware of is the discussion in #75 . Between that and looking at the source, I understand the behavior and it's fine, but:

  • it's hard to find
  • it's not a contract in the way documentation is, and relying on undocumented behavior and a four year old issue is bad practice

Better documentation - especially the information about ClientWrapper handling the caching internally - would making getting started with deadpool_postgress that much easier.

jaskij avatar Nov 03 '24 19:11 jaskij

A PR to add this documentation would be highly appreciated! :heart:

bikeshedder avatar Nov 04 '24 11:11 bikeshedder