prepared_statement.h

Go to the documentation of this file.

#pragma once
 
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "api.h"
#include "query_summary.h"
 
namespace kuzu {
namespace common {
class LogicalType;
}
namespace parser {
class Statement;
}
 
namespace main {
 
// Prepared statement cached in client context and NEVER serialized to client side.
struct CachedPreparedStatement {
    bool useInternalCatalogEntry = false;
    std::shared_ptr<parser::Statement> parsedStatement;
    std::unique_ptr<planner::LogicalPlan> logicalPlan;
    std::vector<std::shared_ptr<binder::Expression>> columns;
 
    CachedPreparedStatement();
    ~CachedPreparedStatement();
 
    std::vector<std::string> getColumnNames() const;
    std::vector<common::LogicalType> getColumnTypes() const;
};

class PreparedStatement {
    friend class Connection;
    friend class ClientContext;
    friend class testing::TestHelper;
    friend class testing::TestRunner;
 
public:
    KUZU_API ~PreparedStatement();
    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>>& getParameterMapUnsafe() {
        return parameterMap;
    }
 
    std::string getName() const { return cachedPreparedStatementName; }
 
    common::StatementType getStatementType() const;
 
    void validateExecuteParam(const std::string& paramName, common::Value* param) const;
 
    static std::unique_ptr<PreparedStatement> getPreparedStatementWithError(
        const std::string& errorMessage);
 
private:
    bool success = true;
    bool readOnly = true;
    std::string errMsg;
    PreparedSummary preparedSummary;
    std::string cachedPreparedStatementName;
    std::unordered_map<std::string, std::shared_ptr<common::Value>> parameterMap;
};
 
} // namespace main
} // namespace kuzu