kuzu::main::PreparedStatement Class Reference

A prepared statement is a parameterized query which can avoid planning the same query for repeated execution. More...

#include <prepared_statement.h>

Public Member Functions
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 ()
std::string	getName () const
common::StatementType	getStatementType () const
void	validateExecuteParam (const std::string &paramName, common::Value *param) const

Static Public Member Functions
static std::unique_ptr< PreparedStatement >	getPreparedStatementWithError (const std::string &errorMessage)

Friends
class	Connection
class	ClientContext
class	testing::TestHelper
class	testing::TestRunner

Detailed Description

A prepared statement is a parameterized query which can avoid planning the same query for repeated execution.

Constructor & Destructor Documentation

~PreparedStatement()

KUZU_API kuzu::main::PreparedStatement::~PreparedStatement

(

)

Member Function Documentation

getErrorMessage()

KUZU_API std::string kuzu::main::PreparedStatement::getErrorMessage

(

)

const

Returns

the error message if the query is not prepared successfully.

getName()

std::string kuzu::main::PreparedStatement::getName ( ) const

inline

getParameterMapUnsafe()

std::unordered_map< std::string, std::shared_ptr< common::Value > > & kuzu::main::PreparedStatement::getParameterMapUnsafe ( )

inline

getPreparedStatementWithError()

std::unique_ptr< PreparedStatement > kuzu::main::PreparedStatement::getPreparedStatementWithError ( const std::string & errorMessage )

static

getStatementType()

common::StatementType kuzu::main::PreparedStatement::getStatementType

(

)

const

isReadOnly()

KUZU_API bool kuzu::main::PreparedStatement::isReadOnly

(

)

const

Returns

the prepared statement is read-only or not.

isSuccess()

KUZU_API bool kuzu::main::PreparedStatement::isSuccess

(

)

const

Returns

the query is prepared successfully or not.

validateExecuteParam()

void kuzu::main::PreparedStatement::validateExecuteParam	(	const std::string &	paramName,
		common::Value *	param ) const

Friends And Related Symbol Documentation

ClientContext

friend class ClientContext

friend

Connection

friend class Connection

friend

testing::TestHelper

friend class testing::TestHelper

friend

testing::TestRunner

friend class testing::TestRunner

friend

---

The documentation for this class was generated from the following file:

• headers/prepared_statement.h