MySQL 8.4.1
Source Code Documentation
s_mysql_mysql_text_consumer_row_factory_v1 Struct Reference

A service that provides the apis for start_row, abort_row and end_row. More...

#include <mysql_command_consumer.h>

Public Attributes

mysql_service_status_t(* start_row )(SRV_CTX_H srv_ctx_h)
 Indicates the beginning of a new row in the result set/metadata. More...
 
mysql_service_status_t(* abort_row )(SRV_CTX_H srv_ctx_h)
 An error occurred during execution. More...
 
mysql_service_status_t(* end_row )(SRV_CTX_H srv_ctx_h)
 Indicates the end of the current row in the result set/metadata. More...
 

Detailed Description

A service that provides the apis for start_row, abort_row and end_row.

Member Data Documentation

◆ abort_row

mysql_service_status_t(* s_mysql_mysql_text_consumer_row_factory_v1::abort_row) (SRV_CTX_H srv_ctx_h)

An error occurred during execution.

This api indicates that an error occurred during command execution and the partial row should be dropped. Server will raise error and return.

Parameters
srv_ctx_hDom_ctx data handle.
Returns
status of operation
Return values
falsesuccess.
truefailure.

◆ end_row

mysql_service_status_t(* s_mysql_mysql_text_consumer_row_factory_v1::end_row) (SRV_CTX_H srv_ctx_h)

Indicates the end of the current row in the result set/metadata.

Parameters
srv_ctx_hDom_ctx data handle.
Returns
status of operation
Return values
falsesuccess.
truefailure.

◆ start_row

mysql_service_status_t(* s_mysql_mysql_text_consumer_row_factory_v1::start_row) (SRV_CTX_H srv_ctx_h)

Indicates the beginning of a new row in the result set/metadata.

Parameters
srv_ctx_hDom_ctx data handle.
Returns
status of operation
Return values
falsesuccess.
truefailure.

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