#@<OUT> shellresult
NAME
      ShellResult - Encapsulates custom query result and metadata.

DESCRIPTION
      This class allows access to a custom result set created through
      shell.create_result.

PROPERTIES
      affected_items_count
            The the number of affected items for the last operation.

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

      column_count
            Retrieves the number of columns on the current result.

      column_names
            Gets the columns on the current result.

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

      execution_time
            Retrieves a string value indicating the execution time of the
            operation that generated this result.

      info
            Retrieves a string providing additional information about the
            result.

      warnings
            Retrieves the warnings generated by operation that generated this
            result.

      warnings_count
            The number of warnings produced by the operation that generated
            this result.

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

      fetch_one()
            Retrieves the next Row on the ShellResult.

      get_affected_items_count()
            The the number of affected items for the last operation.

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

      get_column_count()
            Retrieves the number of columns on the current result.

      get_column_names()
            Gets the columns on the current result.

      get_columns()
            Gets the column metadata for the columns on the current result.

      get_execution_time()
            Retrieves a string value indicating the execution time of the
            operation that generated this result.

      get_info()
            Retrieves a string providing additional information about the
            result.

      get_warnings()
            Retrieves the warnings generated by operation that generated this
            result.

      get_warnings_count()
            The number of warnings produced by the operation that generated
            this result.

      has_data()
            Returns true if there are records in the result.

      help([member])
            Provides help about this class and it's members

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

#@<OUT> shellresult.affected_items_count
NAME
      affected_items_count - The the number of affected items for the last
                             operation.

SYNTAX
      <ShellResult>.affected_items_count

#@<OUT> shellresult.column_count
NAME
      column_count - Retrieves the number of columns on the current result.

SYNTAX
      <ShellResult>.column_count

#@<OUT> shellresult.column_names
NAME
      column_names - Gets the columns on the current result.

SYNTAX
      <ShellResult>.column_names

#@<OUT> shellresult.columns
NAME
      columns - Gets the column metadata for the columns on the current result.

SYNTAX
      <ShellResult>.columns

#@<OUT> shellresult.execution_time
NAME
      execution_time - Retrieves a string value indicating the execution time
                       of the operation that generated this result.

SYNTAX
      <ShellResult>.execution_time

#@<OUT> shellresult.fetch_all
NAME
      fetch_all - Returns a list of Row objects which contains an element for
                  every record left on the result.

SYNTAX
      <ShellResult>.fetch_all()

RETURNS
      A List of Row objects.

DESCRIPTION
      This function will return a Row for every record on the resultset unless
      fetch_one is called before, in such case it will return a Row for each of
      the remaining records on the resultset.

#@<OUT> shellresult.fetch_one
NAME
      fetch_one - Retrieves the next Row on the ShellResult.

SYNTAX
      <ShellResult>.fetch_one()

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

#@<OUT> shellresult.get_affected_items_count
NAME
      get_affected_items_count - The the number of affected items for the last
                                 operation.

SYNTAX
      <ShellResult>.get_affected_items_count()

RETURNS
      the number of affected items.

#@<OUT> shellresult.get_column_count
NAME
      get_column_count - Retrieves the number of columns on the current result.

SYNTAX
      <ShellResult>.get_column_count()

RETURNS
      the number of columns on the current result.

#@<OUT> shellresult.get_column_names
NAME
      get_column_names - Gets the columns on the current result.

SYNTAX
      <ShellResult>.get_column_names()

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

#@<OUT> shellresult.get_columns
NAME
      get_columns - Gets the column metadata for the columns on the current
                    result.

SYNTAX
      <ShellResult>.get_columns()

RETURNS
      a list of column metadata objects containing information about the
      columns included on the current result.

#@<OUT> shellresult.get_execution_time
NAME
      get_execution_time - Retrieves a string value indicating the execution
                           time of the operation that generated this result.

SYNTAX
      <ShellResult>.get_execution_time()

#@<OUT> shellresult.get_info
NAME
      get_info - Retrieves a string providing additional information about the
                 result.

SYNTAX
      <ShellResult>.get_info()

RETURNS
      a string with the additional information.

#@<OUT> shellresult.get_warnings_count
NAME
      get_warnings_count - The number of warnings produced by the operation
                           that generated this result.

SYNTAX
      <ShellResult>.get_warnings_count()

RETURNS
      the number of warnings.

DESCRIPTION
      See get_warnings() for more details.

#@<OUT> shellresult.get_warnings
NAME
      get_warnings - Retrieves the warnings generated by operation that
                     generated this result.

SYNTAX
      <ShellResult>.get_warnings()

RETURNS
      a list containing a warning object for each generated warning.

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

      This information includes: level, code and message.

#@<OUT> shellresult.has_data
NAME
      has_data - Returns true if there are records in the result.

SYNTAX
      <ShellResult>.has_data()

#@<OUT> shellresult.help
NAME
      help - Provides help about this class and it's members

SYNTAX
      <ShellResult>.help([member])

WHERE
      member: If specified, provides detailed information on the given member.

#@<OUT> shellresult.info
NAME
      info - Retrieves a string providing additional information about the
             result.

SYNTAX
      <ShellResult>.info

#@<OUT> shellresult.next_result
NAME
      next_result - Prepares the ShellResult to start reading data from the
                    next Result (if many results were returned).

SYNTAX
      <ShellResult>.next_result()

RETURNS
      A boolean value indicating whether there is another result or not.

#@<OUT> shellresult.warnings_count
NAME
      warnings_count - The number of warnings produced by the operation that
                       generated this result.

SYNTAX
      <ShellResult>.warnings_count

#@<OUT> shellresult.warnings
NAME
      warnings - Retrieves the warnings generated by operation that generated
                 this result.

SYNTAX
      <ShellResult>.warnings

