summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_reset_connection.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_reset_connection.3')
-rw-r--r--libmariadb/man/mysql_reset_connection.348
1 files changed, 48 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_reset_connection.3 b/libmariadb/man/mysql_reset_connection.3
new file mode 100644
index 00000000..8cd4ef5c
--- /dev/null
+++ b/libmariadb/man/mysql_reset_connection.3
@@ -0,0 +1,48 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_reset_connection" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_reset_connection \- Resets connection and clears session state
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+int mysql_reset_connection(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Resets the current connection and clears session state.
+Similar to \f[B]mysql_change_user(3)\f[R] or
+\f[B]mariadb_reconnect(3)\f[R], mysql_reset_connection() resets session
+status, but without disconnecting, opening, or reauthenticating.
+.PP
+On client side mysql_reset_connection() * clears pending or unprocessed
+result sets * clears status like affected_rows, info or last_insert_id *
+invalidates active prepared statements
+.PP
+On server side mysql_reset_connection() * drops temporary table(s) *
+rollbacks active transaction * resets autocommit mode * releases table
+locks * initializes session variables (and sets them to the value of
+corresponding global variables) * closes active prepared statements *
+clears user variables
+.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].
+.SS Return value
+.PP
+Returns zero on success, non zero if an error occurred.
+.SS History
+.PP
+This function was added in MariaDB Connector/C 3.0.0.
+.SS See also
+.IP \[bu] 2
+\f[B]mariadb_cancel(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_kill(3)\f[R]