prepared_statement.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
#include <string>
#include <unordered_map>
 
#include "api.h"
#include "kuzu_fwd.h"
#include "statement.h"
#include "query_summary.h"
 
namespace kuzu {
namespace main {

class PreparedStatement {
    friend class Connection;
    friend class ClientContext;
    friend class testing::TestHelper;
    friend class testing::TestRunner;
 
public:
    bool isTransactionStatement() const;
    KUZU_API bool isSuccess() const;
    KUZU_API std::string getErrorMessage() const;
    KUZU_API bool isReadOnly() const;
 
    std::unordered_map<std::string, std::shared_ptr<common::Value>> getParameterMap() {
        return parameterMap;
    }
 
    common::StatementType getStatementType() const;
 
    KUZU_API ~PreparedStatement();
 
private:
    bool isProfile() const;
 
private:
    bool success = true;
    bool readOnly = false;
    bool useInternalCatalogEntry = false;
    std::string errMsg;
    PreparedSummary preparedSummary;
    std::unordered_map<std::string, std::shared_ptr<common::Value>> parameterMap;
    std::unique_ptr<binder::BoundStatementResult> statementResult;
    std::unique_ptr<planner::LogicalPlan> logicalPlan;
    std::shared_ptr<parser::Statement> parsedStatement;
};
 
} // namespace main
} // namespace kuzu