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

Allows browsing through the result information after performing an operation on the database through the MySQL Protocol. More...

Methods

Row fetchOne ()
 Retrieves the next Row on the ClassicResult. More...
 
Dictionary fetchOneObject ()
 Retrieves the next Row on the result and returns it as an object. More...
 
List fetchAll ()
 Returns a list of Row objects which contains an element for every record left on the result. More...
 
Integer getAffectedItemsCount ()
 The the number of affected items for the last operation. More...
 
Integer getColumnCount ()
 Retrieves the number of columns on the current result. More...
 
List getColumnNames ()
 Gets the columns on the current result. More...
 
List getColumns ()
 Gets the column metadata for the columns on the active result. More...
 
String getExecutionTime ()
 Retrieves a string value indicating the execution time of the executed operation.
 
Bool hasData ()
 Returns true if the last statement execution has a result set.
 
String getInfo ()
 Retrieves a string providing information about the most recently executed statement. More...
 
Integer getAutoIncrementValue ()
 Returns the last insert id auto generated (from an insert operation). More...
 
Integer getWarningsCount ()
 The number of warnings produced by the last statement execution. More...
 
List getWarnings ()
 Retrieves the warnings generated by the executed operation. More...
 
Bool nextResult ()
 Prepares the SqlResult to start reading data from the next Result (if many results were returned). More...
 
String getStatementId ()
 Retrieves the statement id of the query that produced this result. More...
 

Properties

Integer affectedItemsCount
 Same as getAffectedItemsCount()
 
Integer columnCount
 Same as getColumnCount()
 
List columnNames
 Same as getColumnNames()
 
List columns
 Same as getColumns()
 
String executionTime
 Same as getExecutionTime()
 
String info
 Same as getInfo()
 
Integer autoIncrementValue
 Same as getAutoIncrementValue()
 
List warnings
 Same as getWarnings()
 
String statementId
 Same as getStatementId()
 
Integer warningsCount
 Same as getWarningsCount()
 

Detailed Description

Allows browsing through the result information after performing an operation on the database through the MySQL Protocol.

This class allows access to the result set from the classic MySQL data model to be retrieved from Dev API queries.

Member Function Documentation

◆ fetchOne()

Row fetchOne ( )

Retrieves the next Row on the ClassicResult.

Returns
A Row object representing the next record in the result.

◆ fetchOneObject()

Dictionary fetchOneObject ( )

Retrieves the next Row on the result and returns it as an object.

Returns
A dictionary containing the row information.

The column names will be used as keys in the returned dictionary and the column data will be used as the key values.

If a column is a valid identifier it will be accessible as an object attribute as <dict>.<column>.

If a column is not a valid identifier, it will be accessible as a dictionary key as <dict>[<column>].

◆ fetchAll()

List fetchAll ( )

Returns a list of Row objects which contains an element for every record left on the result.

Returns
A List of Row objects.

If this function is called right after executing a query, it will return a Row for every record on the resultset.

If fetchOne is called before this function, when this function is called it will return a Row for each of the remaining records on the resultset.

◆ getAffectedItemsCount()

Integer getAffectedItemsCount ( )

The the number of affected items for the last operation.

Returns
the number of affected items.

◆ getColumnCount()

Integer getColumnCount ( )

Retrieves the number of columns on the current result.

Returns
the number of columns on the current result.

◆ getColumnNames()

List getColumnNames ( )

Gets the columns on the current result.

Returns
A list with the names of the columns returned on the active result.

◆ getColumns()

List getColumns ( )

Gets the column metadata for the columns on the active result.

Returns
a list of column metadata objects containing information about the columns included on the active result.

◆ getInfo()

String getInfo ( )

Retrieves a string providing information about the most recently executed statement.

Returns
a string with the execution information.

For more details, see: https://dev.mysql.com/doc/c-api/en/mysql-info.html

◆ getAutoIncrementValue()

Integer getAutoIncrementValue ( )

Returns the last insert id auto generated (from an insert operation).

Returns
the integer representing the last insert id.

For more details, see https://dev.mysql.com/doc/c-api/en/mysql-insert-id.html

◆ 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/c-api/en/mysql-warning-count.html

See getWarnings() for more details.

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.

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

This information includes: level, code and message.

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

◆ nextResult()

Bool nextResult ( )

Prepares the SqlResult to start reading data from the next Result (if many results were returned).

Returns
A boolean value indicating whether there is another esult or not.

◆ getStatementId()

String getStatementId ( )

Retrieves the statement id of the query that produced this result.

Returns
a string value containing the statement id of query that produced this result.

The statement id will be available as long as the following conditions are met:

  • The statement_id session tracker is enabled.
  • The result has been consumed.

The statement_id session tracker is enabled by configuring the value of the session_track_system_variables session variable in any of the following ways:

  • The value '*' which enables all the session trackers.
  • The value contains 'statement_id' which enables the statement_id session tracker.

If any of the above conditions is not met, the function will return an empty string.