Skip to main content Link Menu Expand (external link) Document Search Copy Copied
KùzuDB

PreparedStatement

PreparedStatement is a parameterized query which can avoid planning the same query for repeated execution.

Example 

auto preparedStatement = conn->prepare("MATCH (a:person) WHERE a.isStudent = $1 RETURN COUNT(*)");
auto result = conn->execute(preparedStatement.get(), std::make_pair(std::string("1"), true));

Available APIs

class kuzu::main::PreparedStatement

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

allowActiveTransaction

bool allowActiveTransaction ()

DDL and COPY_CSV statements are automatically wrapped in a transaction and committed. As such, they cannot be part of an active transaction.

Returns:

  • the prepared statement is allowed to be part of an active transaction.

getErrorMessage

std::string getErrorMessage ()

Returns:

  • the error message if the query is not prepared successfully.

isReadOnly

bool isReadOnly ()

Returns:

  • the prepared statement is read-only or not.

isSuccess

bool isSuccess ()

Returns:

  • the query is prepared successfully or not.