|
MySQL Shell API 9.1.0
Unified development interface for MySQL Products
|
Allows browsing through the result information after performing an operation on the database through the MySQL Protocol. More...
Methods | |
| Row | fetch_one () |
| Retrieves the next Row on the ClassicResult. More... | |
| dict | fetch_one_object () |
| Retrieves the next Row on the result and returns it as an object. More... | |
| list | fetch_all () |
| Returns a list of Row objects which contains an element for every record left on the result. More... | |
| int | get_affected_items_count () |
| The the number of affected items for the last operation. More... | |
| int | get_column_count () |
| Retrieves the number of columns on the current result. More... | |
| list | get_column_names () |
| Gets the columns on the current result. More... | |
| list | get_columns () |
| Gets the column metadata for the columns on the active result. More... | |
| str | get_execution_time () |
| Retrieves a string value indicating the execution time of the executed operation. | |
| bool | has_data () |
| Returns true if the last statement execution has a result set. | |
| str | get_info () |
| Retrieves a string providing information about the most recently executed statement. More... | |
| int | get_auto_increment_value () |
| Returns the last insert id auto generated (from an insert operation). More... | |
| int | get_warnings_count () |
| The number of warnings produced by the last statement execution. More... | |
| list | get_warnings () |
| Retrieves the warnings generated by the executed operation. More... | |
| bool | next_result () |
| Prepares the SqlResult to start reading data from the next Result (if many results were returned). More... | |
| str | get_statement_id () |
| Retrieves the statement id of the query that produced this result. More... | |
Properties | |
| int | affected_items_count |
| Same as get_affected_items_count() | |
| int | column_count |
| Same as get_column_count() | |
| list | column_names |
| Same as get_column_names() | |
| list | columns |
| Same as get_columns() | |
| str | execution_time |
| Same as get_execution_time() | |
| str | info |
| Same as get_info() | |
| int | auto_increment_value |
| Same as get_auto_increment_value() | |
| list | warnings |
| Same as get_warnings() | |
| str | statement_id |
| Same as get_statement_id() | |
| int | warnings_count |
| Same as get_warnings_count() | |
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.
| Row fetch_one | ( | ) |
Retrieves the next Row on the ClassicResult.
| dict fetch_one_object | ( | ) |
Retrieves the next Row on the result and returns it as an object.
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>].
| list fetch_all | ( | ) |
Returns a list of Row objects which contains an element for every record left on the result.
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.
| int get_affected_items_count | ( | ) |
The the number of affected items for the last operation.
| int get_column_count | ( | ) |
Retrieves the number of columns on the current result.
| list get_column_names | ( | ) |
Gets the columns on the current result.
| list get_columns | ( | ) |
Gets the column metadata for the columns on the active result.
| str get_info | ( | ) |
Retrieves a string providing information about the most recently executed statement.
For more details, see: https://dev.mysql.com/doc/c-api/en/mysql-info.html
| int get_auto_increment_value | ( | ) |
Returns the last insert id auto generated (from an insert operation).
For more details, see https://dev.mysql.com/doc/c-api/en/mysql-insert-id.html
| int get_warnings_count | ( | ) |
The number of warnings produced by the last statement execution.
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 get_warnings() for more details.
| list get_warnings | ( | ) |
Retrieves the warnings generated by the executed operation.
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
| bool next_result | ( | ) |
Prepares the SqlResult to start reading data from the next Result (if many results were returned).
| str get_statement_id | ( | ) |
Retrieves the statement id of the 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 by configuring the value of the session_track_system_variables session variable in any of the following ways:
If any of the above conditions is not met, the function will return an empty string.
1.9.2