MySQL 8.3.0
Source Code Documentation
s_mysql_mysql_text_consumer_error_v1 Struct Reference

A service that provides the apis for handle_ok, handle_error and error. More...

#include <mysql_command_consumer.h>

Public Attributes

void(* handle_ok )(SRV_CTX_H srv_ctx_h, unsigned int server_status, unsigned int statement_warn_count, unsigned long long affected_rows, unsigned long long last_insert_id, const char *const message)
 Command ended with success. More...
 
void(* handle_error )(SRV_CTX_H srv_ctx_h, unsigned int sql_errno, const char *const err_msg, const char *const sqlstate)
 Command ended with ERROR, updating the error info into srv_ctx_h. More...
 
mysql_service_status_t(* error )(SRV_CTX_H srv_ctx_h, unsigned int *err_num, const char **error_msg)
 Getting the error info from srv_ctx_h. More...
 

Detailed Description

A service that provides the apis for handle_ok, handle_error and error.

Member Data Documentation

◆ error

mysql_service_status_t(* s_mysql_mysql_text_consumer_error_v1::error) (SRV_CTX_H srv_ctx_h, unsigned int *err_num, const char **error_msg)

Getting the error info from srv_ctx_h.

Parameters
srv_ctx_hDom_ctx data handle.
err_numError code
error_msgError message
Returns
status of operation
Return values
falsesuccess.
truefailure.

◆ handle_error

void(* s_mysql_mysql_text_consumer_error_v1::handle_error) (SRV_CTX_H srv_ctx_h, unsigned int sql_errno, const char *const err_msg, const char *const sqlstate)

Command ended with ERROR, updating the error info into srv_ctx_h.

Parameters
srv_ctx_hDom_ctx data handle.
sql_errnoError code
err_msgError message
sqlstateSQL state corresponding to the error code

◆ handle_ok

void(* s_mysql_mysql_text_consumer_error_v1::handle_ok) (SRV_CTX_H srv_ctx_h, unsigned int server_status, unsigned int statement_warn_count, unsigned long long affected_rows, unsigned long long last_insert_id, const char *const message)

Command ended with success.

Parameters
srv_ctx_hDom_ctx data handle.
server_statusStatus of server (see mysql_com.h, SERVER_STATUS_*)
statement_warn_countNumber of warnings thrown during execution
affected_rowsNumber of rows affected by the command
last_insert_idLast insert id being assigned during execution
messageA message from server

The documentation for this struct was generated from the following file: