MySQL Shell API 8.0.29
Unified development interface for MySQL Products
Methods | Properties | List of all members
BaseResult Class Reference

Base class for the different types of results returned by the server. More...

Methods

int get_affected_items_count ()
 The the number of affected items for the last operation. More...
 
int get_warnings_count ()
 The number of warnings produced by the last statement execution. More...
 
int get_warning_count ()
 The number of warnings produced by the last statement execution. More...
 
list get_warnings ()
 Retrieves the warnings generated by the executed operation. More...
 
str get_execution_time ()
 Retrieves a string value indicating the execution time of the executed operation.
 

Properties

int affected_items_count
 Same as get_affected_items_count()
 
int warning_count
 Same as get_warning_count() More...
 
int warnings_count
 Same as get_warnings_count()
 
list warnings
 Same as get_warnings()
 
str execution_time
 Same as get_execution_time()
 

Detailed Description

Base class for the different types of results returned by the server.

Member Function Documentation

◆ get_affected_items_count()

int get_affected_items_count ( )

The the number of affected items for the last operation.

Returns
the number of affected items.

Returns the number of records affected by the executed operation.

◆ get_warnings_count()

int get_warnings_count ( )

The number of warnings produced by the last statement execution.

Returns
the number of warnings.

This is the same value than C API mysql_warning_count, see https://dev.mysql.com/doc/refman/en/mysql-warning-count.html

See get_warnings() for more details.

See also
warnings

◆ get_warning_count()

int get_warning_count ( )

The number of warnings produced by the last statement execution.

Returns
the number of warnings.
Attention
This function will be removed in a future release, use the get_warnings_count function instead.

This is the same value than C API mysql_warning_count, see https://dev.mysql.com/doc/refman/en/mysql-warning-count.html

See get_warnings() for more details.

See also
warnings

◆ get_warnings()

list get_warnings ( )

Retrieves the warnings generated by the executed operation.

Returns
A list containing a warning object for each generated warning.

This is the same value than C API mysql_warning_count, see https://dev.mysql.com/doc/refman/en/mysql-warning-count.html

Each warning object contains a key/value pair describing the information related to a specific warning.

This information includes: Level, Code and Message.

Member Data Documentation

◆ warning_count

int warning_count

Same as get_warning_count()

Attention
This property will be removed in a future release, use the warnings_count property instead.