diff options
Diffstat (limited to 'libmariadb/man/mysql_query.3')
-rw-r--r-- | libmariadb/man/mysql_query.3 | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_query.3 b/libmariadb/man/mysql_query.3 new file mode 100644 index 00000000..f416d426 --- /dev/null +++ b/libmariadb/man/mysql_query.3 @@ -0,0 +1,56 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mysql_query" "3" "" "Version 3.3.1" "MariaDB Connector/C" +.hy +.SS Name +.PP +mysql_query \- executes a null terminated statement string +.SS Synopsis +.IP +.nf +\f[C] +#include <mysql.h> + +int mysql_query(MYSQL * mysql, + const char * query); +\f[R] +.fi +.SS Description +.PP +Performs a statement pointed to by the null terminate string query +against the database. +Contrary to \f[B]mysql_real_query(3)\f[R], mysql_query() is not binary +safe. +.SS Parameter +.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] \-a null terminated string containing the statement to +be performed. +.SS Notes +.IP \[bu] 2 +For executing multi statements the statements within the null terminated +string statements must be separated by a semicolon. +.IP \[bu] 2 +If your statement contains binary data you should use +\f[B]mysql_real_query(3)\f[R] or escape your data with +\f[B]mysql_hex_string(3)\f[R]. +.IP \[bu] 2 +To determine if a statement returned a result set use the function +\f[B]mysql_field_count(3)\f[R]. +.SS Return value +.PP +Returns zero on success, non zero on failure. +.SS See also +.IP \[bu] 2 +\f[B]mysql_real_query(3)\f[R] +.IP \[bu] 2 +\f[B]mysql_field_count(3)\f[R] +.IP \[bu] 2 +\f[B]mysql_hex_string(3)\f[R] +.IP \[bu] 2 +\f[B]mysql_use_result(3)\f[R] +.IP \[bu] 2 +\f[B]mysql_store_result(3)\f[R] |