MySQL Shell API  8.0.18
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

Integer getAffectedItemsCount ()
 The the number of affected items for the last operation. More...
 
Integer getWarningsCount ()
 The number of warnings produced by the last statement execution. More...
 
Integer getWarningCount ()
 The number of warnings produced by the last statement execution. More...
 
List getWarnings ()
 Retrieves the warnings generated by the executed operation. More...
 
String getExecutionTime ()
 Retrieves a string value indicating the execution time of the executed operation.
 

Properties

Integer affectedItemsCount
 Same as getAffectedItemsCount()
 
Integer warningCount
 Same as getWarningCount() More...
 
Integer warningsCount
 Same as getWarningsCount()
 
List warnings
 Same as getWarnings()
 
String executionTime
 Same as getExecutionTime()
 

Detailed Description

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

Member Function Documentation

◆ getAffectedItemsCount()

Integer getAffectedItemsCount ( )

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

◆ getWarningsCount()

Integer getWarningsCount ( )

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 also
warnings

◆ getWarningCount()

Integer getWarningCount ( )

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

Attention
This function will be removed in a future release, use the  getWarningsCount function instead.
See also
warnings

◆ getWarnings()

List getWarnings ( )

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

◆ warningCount

Integer warningCount

Same as getWarningCount()

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