s_mysql_mysql_text_consumer_metadata_v1 Struct Reference

A service that provides the apis for start_result_metadata, field_metadata, and end_result_metadata. More...

#include <mysql_command_consumer.h>

Public Attributes
mysql_service_status_t(*	start_result_metadata )(SRV_CTX_H srv_ctx_h, unsigned int num_cols, unsigned int flags, const char *const collation_name)
	Indicates beginning of metadata for the result set. More...
mysql_service_status_t(*	field_metadata )(SRV_CTX_H srv_ctx_h, struct Field_metadata *field, const char *const collation_name)
	Field metadata is provided to srv_ctx_h via this service api. More...
mysql_service_status_t(*	end_result_metadata )(SRV_CTX_H srv_ctx_h, unsigned int server_status, unsigned warn_count)
	Indicates end of metadata for the result set. More...

Detailed Description

A service that provides the apis for start_result_metadata, field_metadata, and end_result_metadata.

Member Data Documentation

end_result_metadata

mysql_service_status_t(* s_mysql_mysql_text_consumer_metadata_v1::end_result_metadata) (SRV_CTX_H srv_ctx_h, unsigned int server_status, unsigned warn_count)

Indicates end of metadata for the result set.

Parameters

srv_ctx_h	Dom_ctx data handle.
server_status	server status.
warn_count	warning count of current stmt.

Returns

status of operation

Return values

false	success.
true	failure.

field_metadata

mysql_service_status_t(* s_mysql_mysql_text_consumer_metadata_v1::field_metadata) (SRV_CTX_H srv_ctx_h, struct Field_metadata *field, const char *const collation_name)

Field metadata is provided to srv_ctx_h via this service api.

Parameters

srv_ctx_h	Dom_ctx data handle
field	Field's metadata (see field.h)
collation_name	Field's charset

Returns

status of operation

Return values

false	success. srv_ctx_h field information prepared.
true	failure. invalid srv_ctx_h.

start_result_metadata

mysql_service_status_t(* s_mysql_mysql_text_consumer_metadata_v1::start_result_metadata) (SRV_CTX_H srv_ctx_h, unsigned int num_cols, unsigned int flags, const char *const collation_name)

Indicates beginning of metadata for the result set.

Parameters

srv_ctx_h	Dom_ctx data handle
num_cols	Number of fields being sent
flags	Flags to alter the metadata sending
collation_name	Charset of the result set

Returns

status of operation

Return values

false	success. srv_ctx_h rows were prepared.
true	failure. OOM or invalid srv_ctx_h.

---

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

• include/mysql/components/services/mysql_command_consumer.h