summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_info.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_info.3')
-rw-r--r--libmariadb/man/mysql_info.376
1 files changed, 76 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_info.3 b/libmariadb/man/mysql_info.3
new file mode 100644
index 00000000..2b9cea23
--- /dev/null
+++ b/libmariadb/man/mysql_info.3
@@ -0,0 +1,76 @@
+.\"t
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_info" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_info \- provides information about the last executed statement
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+const char * mysql_info(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+The \f[C]mysql_info()\f[R] function returns a string providing
+information about the last statement executed.
+.SS Parameter
+.IP \[bu] 2
+\f[C]mysql\f[R] \- a connection identifier, which was previously
+allocated by \f[B]mysql_init(3)\f[R] and connected by
+\f[B]mysql_real_connect(3)\f[R].
+.SS Notes
+.PP
+Statements which do not fall into one of the preceding formats are not
+supported (e.g.\ \f[C]SELECT\f[R]).
+In these situations mysql_info() will return an empty string.
+.SS Return value
+.PP
+Zero terminated information string.
+The information depends on statement type:
+.PP
+.TS
+tab(@);
+lw(35.0n) lw(35.0n).
+T{
+Query type
+T}@T{
+Example result string
+T}
+_
+T{
+\f[C]INSERT INTO...SELECT...\f[R]
+T}@T{
+Records: 100 Duplicates: 0 Warnings: 0
+T}
+T{
+\f[C]INSERT INTO...VALUES (...),(...),(...)\f[R]
+T}@T{
+Records: 3 Duplicates: 0 Warnings: 0
+T}
+T{
+\f[C]LOAD DATA INFILE\f[R]
+T}@T{
+Records: 1 Deleted: 0 Skipped: 0 Warnings: 0
+T}
+T{
+\f[C]ALTER TABLE ...\f[R]
+T}@T{
+Records: 3 Duplicates: 0 Warnings: 0
+T}
+T{
+\f[C]UPDATE ...\f[R]
+T}@T{
+Rows matched: 40 Changed: 40 Warnings: 0
+T}
+.TE
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_affected_rows(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_warning_count(3)\f[R]