audacity::sqlite::Statement Class Reference

A class representing a compiled statement. More...

#include <Statement.h>

Collaboration diagram for audacity::sqlite::Statement:

Public Member Functions
	Statement (const Statement &)=delete
	Statement (Statement &&) noexcept
Statement &	operator= (const Statement &)=delete
Statement &	operator= (Statement &&) noexcept
RunContext &	Prepare () noexcept
template<typename... Args>
RunContext &	Prepare (Args &&... args)

Private Member Functions
	Statement (sqlite3_stmt *stmt)

Private Attributes
StatementHandlePtr	mStatement {}
std::optional< RunContext >	mRunContext {}

Friends
class	Connection

Detailed Description

A class representing a compiled statement.

The usage pattern is as follows:

1. Create a Statement object using Connection::CreateStatement
2. Prepare the statement using Statement::Prepare
3. Bind the parameters using RunContext::Bind
4. Execute the statement using RunContext::Run
5. Iterate over the result set using RunResult::begin and RunResult::end

Definition at line 201 of file Statement.h.

Constructor & Destructor Documentation

Statement() [1/3]

audacity::sqlite::Statement::Statement ( sqlite3_stmt *  stmt )

explicitprivate

Definition at line 40 of file Statement.cpp.

    : mStatement { std::make_shared<StatementHandle>(stmt) }
{
}

Statement() [2/3]

audacity::sqlite::Statement::Statement ( const Statement &  )

delete

Statement() [3/3]

audacity::sqlite::Statement::Statement ( Statement &&  rhs )

noexcept

Definition at line 45 of file Statement.cpp.

{
   *this = std::move(rhs);
}

Member Function Documentation

operator=() [1/2]

Statement & audacity::sqlite::Statement::operator= ( const Statement &  )

delete

operator=() [2/2]

Statement & audacity::sqlite::Statement::operator= ( Statement &&  rhs )

noexcept

Definition at line 50 of file Statement.cpp.

{
   std::swap(mStatement, rhs.mStatement);
   return *this;
}

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Prepare() [1/2]

RunContext & audacity::sqlite::Statement::Prepare ( )

noexcept

Definition at line 56 of file Statement.cpp.

{
   mRunContext = RunContext { mStatement };
   return *mRunContext;
}

References mRunContext, and mStatement.

Prepare() [2/2]

template<typename... Args>

RunContext & audacity::sqlite::Statement::Prepare ( Args &&...  args )

inline

Definition at line 216 of file Statement.h.

   {
      return Prepare().BindAll(std::forward<Args>(args)...);
   }

References audacity::sqlite::RunContext::BindAll().

Here is the call graph for this function:

Friends And Related Function Documentation

Connection

friend class Connection

friend

Definition at line 225 of file Statement.h.

Member Data Documentation

mRunContext

std::optional<RunContext> audacity::sqlite::Statement::mRunContext {}

private

Definition at line 223 of file Statement.h.

Referenced by Prepare().

mStatement

StatementHandlePtr audacity::sqlite::Statement::mStatement {}

private

Definition at line 222 of file Statement.h.

Referenced by Prepare().

---

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

• Statement.h
• Statement.cpp