MySQL Shell API 9.0.1
Unified development interface for MySQL Products
|
Encapsulates custom query result and metadata. More...
Methods | |
Row | fetchOne () |
Retrieves the next Row on the ShellResult. 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 | getAutoIncrementValue () |
Returns the last insert id auto generated (from an insert 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 current result. More... | |
String | getExecutionTime () |
Retrieves a string value indicating the execution time of the operation that generated this result. | |
Bool | hasData () |
Returns true if there are records in the result. | |
String | getInfo () |
Retrieves a string providing additional information about the result. More... | |
Integer | getWarningsCount () |
The number of warnings produced by the operation that generated this result. More... | |
List | getWarnings () |
Retrieves the warnings generated by operation that generated this result. More... | |
Bool | nextResult () |
Prepares the ShellResult to start reading data from the next Result (if many results were returned). More... | |
Properties | |
Integer | affectedItemsCount |
Same as getAffectedItemsCount() | |
Integer | autoIncrementValue |
Same as getAutoIncrementValue() | |
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() | |
List | warnings |
Same as getWarnings() | |
Integer | warningsCount |
Same as getWarningsCount() | |
Encapsulates custom query result and metadata.
This class allows access to a custom result set created through shell.createResult.
Row fetchOne | ( | ) |
Retrieves the next Row on the ShellResult.
List fetchAll | ( | ) |
Returns a list of Row objects which contains an element for every record left on the result.
This function will return a Row for every record on the resultset unless fetchOne is called before, in such case it will return a Row for each of the remaining records on the resultset.
Integer getAffectedItemsCount | ( | ) |
The the number of affected items for the last operation.
Integer getAutoIncrementValue | ( | ) |
Returns the last insert id auto generated (from an insert operation).
Integer getColumnCount | ( | ) |
Retrieves the number of columns on the current result.
List getColumnNames | ( | ) |
Gets the columns on the current result.
List getColumns | ( | ) |
Gets the column metadata for the columns on the current result.
String getInfo | ( | ) |
Retrieves a string providing additional information about the result.
Integer getWarningsCount | ( | ) |
The number of warnings produced by the operation that generated this result.
See getWarnings() for more details.
List getWarnings | ( | ) |
Retrieves the warnings generated by operation that generated this result.
Each warning object contains a key/value pair describing the information related to a specific warning.
This information includes: level, code and message.
Bool nextResult | ( | ) |
Prepares the ShellResult to start reading data from the next Result (if many results were returned).