audacity::sqlite Namespace Reference

Namespaces
namespace	anonymous_namespace{SQLiteUtils.cpp}
namespace	details

Classes
class	AggregateFunction
	A class representing an aggregate function in a SQLite database. More...
class	Blob
	A class representing a BLOB in a SQLite database. More...
class	Connection
	A class representing a connection to a SQLite database. More...
class	Error
	A class representing an error in SQLite. More...
class	Result
	A class representing a result of an operation. More...
class	Row
	A class representing a row in a result set. More...
class	RowIterator
	A class representing an iterator over a result set. More...
class	RunContext
	A class representing a context of a run operation. More...
class	RunResult
	A class representing a result of a run operation. More...
class	SafeConnection
	A class representing a safe connection to SQLite. More...
class	ScalarFunction
	A class representing a scalar function in a SQLite database. More...
class	Statement
	A class representing a compiled statement. More...
struct	StatementHandle
class	Transaction
	A class representing a transaction in SQLite. More...

Typedefs
using	LogCallback = std::function< void(int, std::string_view)>
using	StatementHandlePtr = std::shared_ptr< StatementHandle >

Enumerations
enum class	OpenMode { ReadWrite , ReadOnly , ReadWriteCreate , Memory }
	The mode in which the database should be opened. More...
enum class	ThreadMode { MultiThread , Serialized }
	The mode in which the database should be accessed. More...

Functions
Error	Initialize () noexcept
void	SetLogCallback (LogCallback callback)

Typedef Documentation

LogCallback

using audacity::sqlite::LogCallback = typedef std::function<void(int, std::string_view)>

Definition at line 19 of file SQLiteUtils.h.

StatementHandlePtr

using audacity::sqlite::StatementHandlePtr = typedef std::shared_ptr<StatementHandle>

Definition at line 23 of file Statement.h.

Enumeration Type Documentation

OpenMode

enum class audacity::sqlite::OpenMode

strong

The mode in which the database should be opened.

Enumerator
ReadWrite
ReadOnly
ReadWriteCreate
Memory

Definition at line 25 of file Connection.h.

{
   ReadWrite,
   ReadOnly,
   ReadWriteCreate,
   Memory,
};

ThreadMode

enum class audacity::sqlite::ThreadMode

strong

The mode in which the database should be accessed.

Connection is never thread-safe. This mode is used to specify how the multiple connections to the same database should be handled.

Enumerator
MultiThread
Serialized

Definition at line 38 of file Connection.h.

{
   MultiThread,
   Serialized,
};

Function Documentation

Initialize()

SQLITE_HELPERS_API Error audacity::sqlite::Initialize ( )

noexcept

Definition at line 92 of file SQLiteUtils.cpp.

{
   return GetIniter().GetError();
}

References audacity::sqlite::anonymous_namespace{SQLiteUtils.cpp}::SQLiteIniter::GetError(), and audacity::sqlite::anonymous_namespace{SQLiteUtils.cpp}::GetIniter().

Referenced by ProjectFileIO::InitializeSQL(), and audacity::sqlite::Connection::Open().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLogCallback()

SQLITE_HELPERS_API void audacity::sqlite::SetLogCallback

(

LogCallback

callback

)

Definition at line 97 of file SQLiteUtils.cpp.

{
   GetIniter().SetLogCallback(std::move(callback));
}

References audacity::sqlite::anonymous_namespace{SQLiteUtils.cpp}::GetIniter(), and audacity::sqlite::anonymous_namespace{SQLiteUtils.cpp}::SQLiteIniter::SetLogCallback().

Referenced by ProjectFileIO::InitializeSQL().

Here is the call graph for this function:

Here is the caller graph for this function: