Class QueryResult

src/include/main/query_result.h:25–191

* @brief QueryResult stores the result of a query execution. */

 * @brief QueryResult stores the result of a query execution.
 */
class QueryResult {
public:
    /**
     * @brief Used to create a QueryResult object for the failing query.
     */
    LBUG_API QueryResult();
    explicit QueryResult(QueryResultType type);
    QueryResult(QueryResultType type, std::vector<std::string> columnNames,
        std::vector<common::LogicalType> columnTypes);

    /**
     * @brief Deconstructs the QueryResult object.
     */
    LBUG_API virtual ~QueryResult() = 0;
    /**
     * @return if the query is executed successfully or not.
     */
    LBUG_API bool isSuccess() const;
    /**
     * @return error message of the query execution if the query fails.
     */
    LBUG_API std::string getErrorMessage() const;
    /**
     * @return number of columns in query result.
     */
    LBUG_API size_t getNumColumns() const;
    /**
     * @return name of each column in the query result.
     */
    LBUG_API std::vector<std::string> getColumnNames() const;
    /**
     * @return dataType of each column in the query result.
     */
    LBUG_API std::vector<common::LogicalType> getColumnDataTypes() const;
    /**
     * @return query summary which stores the execution time, compiling time, plan and query
     * options.
     */
    LBUG_API QuerySummary* getQuerySummary() const;
    QuerySummary* getQuerySummaryUnsafe();
    /**
     * @return whether there are more query results to read.
     */
    LBUG_API bool hasNextQueryResult() const;
    /**
     * @return get the next query result to read (for multiple query statements).
     */
    LBUG_API QueryResult* getNextQueryResult();
    /**
     * @return num of tuples in query result.
     */
    LBUG_API virtual uint64_t getNumTuples() const = 0;
    /**
     * @return whether there are more tuples to read.
     */
    LBUG_API virtual bool hasNext() const = 0;
    /**
     * @return next flat tuple in the query result. Note that to reduce resource allocation, all