audacity::sqlite::Row Class Reference

A class representing a row in a result set. More...

#include <Statement.h>

Collaboration diagram for audacity::sqlite::Row:

Public Member Functions
bool	Get (int columnIndex, bool &value) const
bool	Get (int columnIndex, int &value) const
bool	Get (int columnIndex, long &value) const
bool	Get (int columnIndex, long long &value) const
bool	Get (int columnIndex, float &value) const
bool	Get (int columnIndex, double &value) const
bool	Get (int columnIndex, std::string &value) const
template<typename T >
T	GetOr (int columnIndex, T defaultValue=T()) const
int	GetColumnCount () const
int64_t	GetColumnBytes (int columnIndex) const
int64_t	ReadData (int columnIndex, void *buffer, int64_t maxSize) const

Private Member Functions
	Row (StatementHandlePtr statement, std::vector< Error > &errors) noexcept
	Row ()=default
template<typename Reader >
bool	DoGet (Reader reader, int columnIndex) const

Private Attributes
StatementHandlePtr	mStatement {}
std::vector< Error > *	mErrors {}
int	mColumnsCount { 0 }

Friends
class	RowIterator

Detailed Description

A class representing a row in a result set.

Indices are 0-based

Definition at line 31 of file Statement.h.

Constructor & Destructor Documentation

Row() [1/2]

audacity::sqlite::Row::Row ( StatementHandlePtr  statement, std::vector< Error > &  errors  )

explicitprivatenoexcept

Definition at line 340 of file Statement.cpp.

    : mStatement { std::move(statement) }
    , mErrors { &errors }
{
   if (mStatement != nullptr)
      mColumnsCount = sqlite3_column_count(*mStatement);
}

Row() [2/2]

audacity::sqlite::Row::Row ( )

privatedefault

Member Function Documentation

DoGet()

template<typename Reader >

bool audacity::sqlite::Row::DoGet ( Reader  reader, int  columnIndex  ) const

private

Definition at line 349 of file Statement.cpp.

{
   if (mStatement == nullptr)
   {
      if (mErrors != nullptr)
         mErrors->emplace_back(Error(SQLITE_MISUSE));
      return false;
   }
 
   if (columnIndex < 0 || columnIndex >= mColumnsCount)
   {
      if (mErrors != nullptr)
         mErrors->emplace_back(Error(SQLITE_RANGE));
      return false;
   }
 
   if constexpr (std::is_void_v<decltype(reader())>)
   {
      reader();
      return true;
   }
   else
      return reader();
}

References mColumnsCount, mErrors, and mStatement.

Referenced by Get().

Here is the caller graph for this function:

Get() [1/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		bool &	value
	)		const

Definition at line 374 of file Statement.cpp.

{
   return DoGet([&] { value = sqlite3_column_int(*mStatement, columnIndex) != 0; }, columnIndex);
}

References DoGet(), and mStatement.

Referenced by audacity::cloud::audiocom::sync::CloudProjectsDatabase::DoGetProjectData().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [2/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		double &	value
	)		const

Definition at line 408 of file Statement.cpp.

{
   return DoGet([&] { value = sqlite3_column_double(*mStatement, columnIndex); },
      columnIndex);
}

References DoGet(), and mStatement.

Here is the call graph for this function:

Get() [3/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		float &	value
	)		const

Definition at line 397 of file Statement.cpp.

{
   return DoGet(
      [&]
      {
         value =
            static_cast<float>(sqlite3_column_double(*mStatement, columnIndex));
      },
      columnIndex);
}

References DoGet(), and mStatement.

Here is the call graph for this function:

Get() [4/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		int &	value
	)		const

Definition at line 379 of file Statement.cpp.

{
   return DoGet([&] { value = sqlite3_column_int(*mStatement, columnIndex); }, columnIndex);
}

References DoGet(), and mStatement.

Here is the call graph for this function:

Get() [5/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		long &	value
	)		const

Definition at line 384 of file Statement.cpp.

{
   if (sizeof(long) == 4)
      return DoGet([&] { value = sqlite3_column_int(*mStatement, columnIndex); }, columnIndex);
   else
      return DoGet([&] { value = sqlite3_column_int64(*mStatement, columnIndex); }, columnIndex);
}

References DoGet(), and mStatement.

Here is the call graph for this function:

Get() [6/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		long long &	value
	)		const

Definition at line 392 of file Statement.cpp.

{
   return DoGet([&] { value = sqlite3_column_int64(*mStatement, columnIndex); }, columnIndex);
}

References DoGet(), and mStatement.

Here is the call graph for this function:

Get() [7/7]

bool audacity::sqlite::Row::Get	(	int	columnIndex,
		std::string &	value
	)		const

Definition at line 414 of file Statement.cpp.

{
   return DoGet(
      [&]
      {
         const auto* text = reinterpret_cast<const char*>(
            sqlite3_column_text(*mStatement, columnIndex));
 
         if (text == nullptr)
            return false;
 
         // Per sqlite convention, text is never nullptr
         value = text;
         return true;
      },
      columnIndex);
}

References DoGet(), and mStatement.

Here is the call graph for this function:

GetColumnBytes()

int64_t audacity::sqlite::Row::GetColumnBytes

(

int

columnIndex

)

const

Definition at line 437 of file Statement.cpp.

{
   return sqlite3_column_bytes(*mStatement, columnIndex);
}

References mStatement.

Referenced by ReadData().

Here is the caller graph for this function:

GetColumnCount()

int audacity::sqlite::Row::GetColumnCount

(

)

const

Definition at line 432 of file Statement.cpp.

{
   return sqlite3_column_count(*mStatement);
}

References mStatement.

GetOr()

template<typename T >

T audacity::sqlite::Row::GetOr ( int  columnIndex, T  defaultValue = T()  ) const

inline

Definition at line 47 of file Statement.h.

   {
      T value;
      return Get(columnIndex, value) ? value : defaultValue;
   }

References BasicUI::Get().

Here is the call graph for this function:

ReadData()

int64_t audacity::sqlite::Row::ReadData	(	int	columnIndex,
		void *	buffer,
		int64_t	maxSize
	)		const

Definition at line 442 of file Statement.cpp.

{
   const auto* data = sqlite3_column_blob(*mStatement, columnIndex);
 
   if (data == nullptr)
      return 0;
 
   const auto size = std::min(maxSize, GetColumnBytes(columnIndex));
 
   std::memcpy(buffer, data, size);
 
   return size;
}

References GetColumnBytes(), min(), mStatement, and size.

Here is the call graph for this function:

Friends And Related Function Documentation

RowIterator

friend class RowIterator

friend

Definition at line 33 of file Statement.h.

Member Data Documentation

mColumnsCount

int audacity::sqlite::Row::mColumnsCount { 0 }

private

Definition at line 64 of file Statement.h.

Referenced by DoGet().

mErrors

std::vector<Error>* audacity::sqlite::Row::mErrors {}

private

Definition at line 63 of file Statement.h.

Referenced by DoGet().

mStatement

StatementHandlePtr audacity::sqlite::Row::mStatement {}

private

Definition at line 62 of file Statement.h.

Referenced by DoGet(), Get(), GetColumnBytes(), GetColumnCount(), and ReadData().

---

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

• Statement.h
• Statement.cpp