ocaml-mysql icon indicating copy to clipboard operation
ocaml-mysql copied to clipboard

Document blocking functions

Open darioteixeira opened this issue 9 years ago • 2 comments

I'm taking a look at ocaml-mysql for interfacing with Google Cloud SQL. Since the application uses Lwt, I'm using Lwt_preemptive.detach to get around ocaml-mysql offering only a blocking API. There is one major hurdle with this approach, however: it's not always obvious which functions block on I/O and which ones don't. It would be nice if the API documentation for ocaml-mysql were explicit on this matter.

darioteixeira avatar Sep 07 '16 12:09 darioteixeira

I think this is better left of for the libmysqlclient documentation, to avoid duplication. For example some libmysqlclient internals might change and the function that was interacting with server may stop doing so or vice versa, do we really want to track all such cases?

ygrek avatar Nov 12 '16 22:11 ygrek

FWIW, my argument above doesn't look convincing to me now. But I am unlikely to work on this myself. Feel free to provide patch or close..

ygrek avatar Jul 04 '17 21:07 ygrek