CViewDatabase Class Reference

#include <ViewDatabase.h>

Inheritance diagram for CViewDatabase:

Public Member Functions
	CViewDatabase ()
	~CViewDatabase () override
bool	Open () override
bool	GetViewState (const std::string &path, int windowID, CViewState &state, const std::string &skin)
bool	SetViewState (const std::string &path, int windowID, const CViewState &state, const std::string &skin)
bool	ClearViewStates (int windowID)
Public Member Functions inherited from CDatabase
	CDatabase (const std::string &dbType)
virtual	~CDatabase ()
bool	IsOpen () const
bool	Open (const DatabaseSettings &db)
virtual void	Close ()
const std::string &	GetType () const
bool	Compress (bool bForce=true)
void	Interrupt ()
void	BeginTransaction ()
virtual bool	CommitTransaction ()
void	RollbackTransaction ()
bool	InTransaction () const
void	CopyDB (const std::string &latestDb)
void	DropAnalytics ()
std::string	PrepareSQL (std::string_view sqlFormat,...) const
std::string	GetSingleValue (const std::string &strTable, const std::string &strColumn, const std::string &strWhereClause=std::string(), const std::string &strOrderBy=std::string()) const
	Get a single value from a table.
std::string	GetSingleValue (const std::string &query) const
std::string	GetSingleValue (const std::string &query, dbiplus::Dataset &ds) const
	Get a single value from a query on a dataset.
int	GetSingleValueInt (const std::string &strTable, const std::string &strColumn, const std::string &strWhereClause=std::string(), const std::string &strOrderBy=std::string()) const
	Get a single integer value from a table.
int	GetSingleValueInt (const std::string &query) const
int	GetSingleValueInt (const std::string &query, dbiplus::Dataset &ds) const
	Get a single integer value from a query on a dataset.
bool	DeleteValues (const std::string &strTable, const Filter &filter=Filter())
	Delete values from a table.
bool	ExecuteQuery (const std::string &strQuery)
	Execute a query that does not return any result. Note that if BeginMultipleExecute() has been called, the query will be queued until CommitMultipleExecute() is called.
bool	ResultQuery (const std::string &strQuery) const
	Execute a query that returns a result.
bool	BeginMultipleExecute ()
	Start a multiple execution queue. Any ExecuteQuery() function following this call will be queued rather than executed until CommitMultipleExecute() is performed. NOTE: Queries that rely on any queued execute query will not function as expected during this period!
bool	CommitMultipleExecute ()
	Commit the multiple execution queue to the database. Queries are performed within a transaction, and the transaction is rolled back should any one query fail.
bool	QueueInsertQuery (const std::string &strQuery)
	Put an INSERT or REPLACE query in the queue.
bool	CommitInsertQueries ()
	Commit all queries in the queue.
size_t	GetInsertQueriesCount () const
	Get the number of INSERT queries in the queue.
bool	QueueDeleteQuery (const std::string &strQuery)
	Put a DELETE query in the queue.
bool	CommitDeleteQueries ()
	Commit all queued DELETE queries.
size_t	GetDeleteQueriesCount () const
	Get the number of DELETE queries in the queue.
virtual bool	GetFilter (CDbUrl &dbUrl, Filter &filter, SortDescription &sorting)
virtual bool	BuildSQL (const std::string &strBaseDir, const std::string &strQuery, Filter &filter, std::string &strSQL, CDbUrl &dbUrl)
virtual bool	BuildSQL (const std::string &strBaseDir, const std::string &strQuery, Filter &filter, std::string &strSQL, CDbUrl &dbUrl, SortDescription &sorting)
ConnectionState	Connect (const std::string &dbName, const DatabaseSettings &db, bool create)
bool	SetArtForItem (int mediaId, const std::string &mediaType, const std::string &artType, const std::string &url)
	Sets art for a library item.
virtual bool	SetArtForItem (int mediaId, const std::string &mediaType, const KODI::ART::Artwork &art)
	Sets each piece of art, a map of art type to url, for a library item.
virtual bool	GetArtForItem (int mediaId, const std::string &mediaType, KODI::ART::Artwork &art)
	Adds the art a library item has to art, a map of art type to url.
std::string	GetArtForItem (int mediaId, const std::string &mediaType, const std::string &artType)
	The url of one type of art for a library item, empty if it has none.
bool	RemoveArtForItem (int mediaId, const std::string &mediaType, const std::string &artType)
bool	RemoveArtForItem (int mediaId, const std::string &mediaType, const std::set< std::string, std::less<> > &artTypes)
bool	GetArtTypes (const std::string &mediaType, std::vector< std::string > &artTypes)
	Adds the distinct types of art held for a type of item to artTypes.
bool	SetArtForItem (int mediaId, KODI::MEDIA::TYPE mediaType, const std::string &artType, const std::string &url)
	The art functions above, for an item whose table is a media type.
bool	SetArtForItem (int mediaId, KODI::MEDIA::TYPE mediaType, const KODI::ART::Artwork &art)
bool	GetArtForItem (int mediaId, KODI::MEDIA::TYPE mediaType, KODI::ART::Artwork &art)
std::string	GetArtForItem (int mediaId, KODI::MEDIA::TYPE mediaType, const std::string &artType)
bool	RemoveArtForItem (int mediaId, KODI::MEDIA::TYPE mediaType, const std::set< std::string, std::less<> > &artTypes)

Protected Member Functions
void	CreateTables () override
void	CreateAnalytics () override
void	UpdateTables (int version) override
int	GetSchemaVersion () const override
const char *	GetBaseDBName () const override
Protected Member Functions inherited from CDatabase
void	Split (const std::string &strFileNameAndPath, std::string &strPath, std::string &strFileName) const
bool	CreateDatabase ()
	Create database tables and analytics as needed. Calls CreateTables() and CreateAnalytics() on child classes.
void	AddAutoIncrement (const std::string &table)
	Rebuild a table so that its integer primary key never hands out a deleted row's id. For UpdateTables() only: the analytics must be dropped. MySQL already declares every integer primary key auto_increment, so there it does nothing.
virtual int	GetMinSchemaVersion () const
int	GetDBVersion ()
bool	BuildSQL (std::string_view strQuery, const Filter &filter, std::string &strSQL) const

Additional Inherited Members
Public Types inherited from CDatabase
enum class	ConnectionState { STATE_ERROR , STATE_DATABASE_NOT_FOUND , STATE_CONNECTED }
Protected Attributes inherited from CDatabase
bool	m_sqlite {true}
	whether we use sqlite (defaults to true)
std::unique_ptr< dbiplus::Database >	m_pDB
std::unique_ptr< dbiplus::Dataset >	m_pDS
std::unique_ptr< dbiplus::Dataset >	m_pDS2
const CProfileManager &	m_profileManager

Constructor & Destructor Documentation

CViewDatabase()

CViewDatabase::CViewDatabase

(

)

~CViewDatabase()

CViewDatabase::~CViewDatabase ( )

overridedefault

Member Function Documentation

ClearViewStates()

bool CViewDatabase::ClearViewStates

(

int

windowID

)

CreateAnalytics()

void CViewDatabase::CreateAnalytics ( )

overrideprotectedvirtual

Implements CDatabase.

CreateTables()

void CViewDatabase::CreateTables ( )

overrideprotectedvirtual

Implements CDatabase.

GetBaseDBName()

const char * CViewDatabase::GetBaseDBName ( ) const

inlineoverrideprotectedvirtual

Implements CDatabase.

GetSchemaVersion()

int CViewDatabase::GetSchemaVersion ( ) const

inlineoverrideprotectedvirtual

Implements CDatabase.

GetViewState()

bool CViewDatabase::GetViewState	(	const std::string &	path,
		int	windowID,
		CViewState &	state,
		const std::string &	skin )

Open()

bool CViewDatabase::Open ( )

overridevirtual

Reimplemented from CDatabase.

SetViewState()

bool CViewDatabase::SetViewState	(	const std::string &	path,
		int	windowID,
		const CViewState &	state,
		const std::string &	skin )

UpdateTables()

void CViewDatabase::UpdateTables ( int version )

overrideprotectedvirtual

Reimplemented from CDatabase.

---

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

• ViewDatabase.h
• ViewDatabase.cpp