diff options
Diffstat (limited to 'libmariadb/man/mysql_send_query.3')
| -rw-r--r-- | libmariadb/man/mysql_send_query.3 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_send_query.3 b/libmariadb/man/mysql_send_query.3 new file mode 100644 index 00000000..dea08137 --- /dev/null +++ b/libmariadb/man/mysql_send_query.3 @@ -0,0 +1,52 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mysql_send_query" "3" "" "Version 3.3.1" "MariaDB Connector/C" +.hy +.SS Name +.PP +mysql_send_query \- sends a SQL statement without waiting for server +reponse +.SS Synopsis +.IP +.nf +\f[C] +#include <mysql.h> + +int mysql_send_query(MYSQL * mysql, + const char *query, + unsigned long length); +\f[R] +.fi +.SS Description +.PP +Sends a statement to the server, without waiting for the Server OK +packet and/or resultset. +.SS Parameters +.IP \[bu] 2 +\f[C]mysql\f[R] \- a mysql handle, which was previously allocated by +\f[B]mysql_init(3)\f[R] and connected by +\f[B]mysql_real_connect(3)\f[R]. +.IP \[bu] 2 +\f[C]query\f[R] \- SQL statement +.IP \[bu] 2 +\f[C]length\f[R] \- length of the SQL statement +.SS Notes +.IP \[bu] 2 +The OK and result set package need to be retrieved by +\f[B]mysql_read_query_result(3)\f[R] function +.IP \[bu] 2 +\f[C]mysql_send_query()\f[R] can be used for semi asynchronous +operation. +While the function itself is blocking, an event driven application can +do other tasks until result set is available. +.SS Example +.PP +For an example how to use \[cq]mysql_send_query()\[ga] in an event +driven model, please check Jan Kneschke\[cq]s article \[lq]Async MySQL +Queries with +C\-API\[rq] (https://jan.kneschke.de/projects/mysql/async-mysql-queries-with-c-api/). +.SS See also +.IP \[bu] 2 +<mysql_real_query> +.IP \[bu] 2 +<mysql_read_query_result> |