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
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 ()
common::StatementType	getStatementType ()
KUZU_API	~PreparedStatement ()

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

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.

getParameterMap()

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

inline

getStatementType()

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

(

)

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.

isTransactionStatement()

bool kuzu::main::PreparedStatement::isTransactionStatement

(

)

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

testing::TinySnbCopyCSVTransactionTest

friend class testing::TinySnbCopyCSVTransactionTest

friend

testing::TinySnbDDLTest

friend class testing::TinySnbDDLTest

friend

---

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

• headers/prepared_statement.h