MySQL :: MySQL 8.0 C API Developer Guide :: 5.4.43 mysql_kill() (original) (raw)

5.4.43 mysql_kill()

int
mysql_kill(MYSQL *mysql,
           unsigned long pid)

Description

Note

mysql_kill() is deprecated and is subject to removal in a future version of MySQL. Instead, usemysql_real_query() ormysql_query() to execute aKILL statement.

Asks the server to kill the thread specified bypid.

mysql_kill() cannot handle values larger than 32 bits, but to guard against killing the wrong thread returns an error in these cases:

• If given an ID larger than 32 bits,mysql_kill() returns aCR_INVALID_CONN_HANDLE error.
• After the server's internal thread ID counter reaches a value larger than 32 bits, it returns anER_DATA_OUT_OF_RANGE error for any mysql_kill() invocation andmysql_kill() fails.

Return Values

Zero for success. Nonzero if an error occurred.

Errors

• CR_COMMANDS_OUT_OF_SYNC
  Commands were executed in an improper order.
• CR_INVALID_CONN_HANDLE
  The pid was larger than 32 bits.
• CR_SERVER_GONE_ERROR
  The MySQL server has gone away.
• CR_SERVER_LOST
  The connection to the server was lost during the query.
• CR_UNKNOWN_ERROR
  An unknown error occurred.
• ER_DATA_OUT_OF_RANGE
  The server's internal thread ID counter has reached a value larger than 32 bits, at which point it rejects allmysql_kill() invocations.