summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_kill.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:24:36 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:24:36 +0000
commit06eaf7232e9a920468c0f8d74dcf2fe8b555501c (patch)
treee2c7b5777f728320e5b5542b6213fd3591ba51e2 /libmariadb/man/mysql_kill.3
parentInitial commit. (diff)
downloadmariadb-06eaf7232e9a920468c0f8d74dcf2fe8b555501c.tar.xz
mariadb-06eaf7232e9a920468c0f8d74dcf2fe8b555501c.zip
Adding upstream version 1:10.11.6.upstream/1%10.11.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libmariadb/man/mysql_kill.3')
-rw-r--r--libmariadb/man/mysql_kill.351
1 files changed, 51 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_kill.3 b/libmariadb/man/mysql_kill.3
new file mode 100644
index 00000000..833a66ea
--- /dev/null
+++ b/libmariadb/man/mysql_kill.3
@@ -0,0 +1,51 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_kill" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_kill \- Kills a connection
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+int mysql_kill(MYSQL * mysql,
+ unsigned long);
+\f[R]
+.fi
+.SS Description
+.PP
+This function is used to ask the server to kill a MariaDB thread
+specified by the processid parameter.
+This value must be retrieved by [show\-processlist()](SHOW
+PROCESSLIST]].
+If trying to kill the own connection \f[B]mysql_thread_id(3)\f[R] should
+be used.
+.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].
+Returns 0 on success, otherwise nonzero.
+.IP \[bu] 2
+\f[C]long\f[R] \- process id
+.SS Notes
+.IP \[bu] 2
+To stop a running command without killing the connection use
+\f[C]KILL QUERY\f[R].
+.IP \[bu] 2
+The \f[C]mysql_kill()\f[R] function only kills a connection, it
+doesn\[cq]t free any memory \- this must be done explicitly by calling
+\f[B]mysql_close(3)\f[R].
+.SS Return value
+.PP
+Returns zero on success, non zero on error.
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_thread_id(3)\f[R]
+.IP \[bu] 2
+\f[B]mysql_close(3)\f[R]
+.IP \[bu] 2
+\f[B]mariadb_cancel(3)\f[R]