#include <PVRDatabase.h>

Inheritance diagram for PVR::CPVRDatabase:

Public Member Functions
	CPVRDatabase (void)=default
	Create a new instance of the PVR database. More...

	~CPVRDatabase (void) override=default

bool	Open () override
	Open the database. More...

void	Close () override
	Close the database. More...

int	GetSchemaVersion () const override
	Get the minimal database version that is required to operate correctly. More...

const char *	GetBaseDBName () const override
	Get the default sqlite database filename. More...

Client methods
bool	DeleteClients ()
	Remove all client entries from the database. More...

bool	Persist (const CPVRClient &client)
	Add or update a client entry in the database. More...

bool	Delete (const CPVRClient &client)
	Remove a client entry from the database. More...

int	GetPriority (const CPVRClient &client)
	Get the priority for a given client from the database. More...

bool	UpdateLastWatched (const CPVRChannel &channel)
	Updates the last watched timestamp for the channel. More...

bool	UpdateLastWatched (const CPVRChannelGroup &group)
	Updates the last watched timestamp for the channel group. More...

Channel methods
bool	DeleteChannels (void)
	Remove all channels from the database. More...

bool	Persist (CPVRChannel &channel, bool bCommit)
	Add or update a channel entry in the database. More...

bool	Delete (const CPVRChannel &channel)
	Remove a channel entry from the database. More...

int	Get (CPVRChannelGroup &results, bool bCompressDB)
	Get the list of channels from the database. More...

Channel group methods
bool	DeleteChannelGroups (void)
	Remove all channel groups from the database. More...

bool	Delete (const CPVRChannelGroup &group)
	Delete a channel group from the database. More...

bool	Get (CPVRChannelGroups &results)
	Get the channel groups. More...

int	Get (CPVRChannelGroup &group, const CPVRChannelGroup &allGroup)
	Add the group members to a group. More...

bool	Persist (CPVRChannelGroup &group)
	Add or update a channel group entry in the database. More...

bool	ResetEPG (void)
	Reset all epg ids to 0. More...

Public Member Functions inherited from CDatabase
	CDatabase ()

virtual	~CDatabase (void)

bool	IsOpen ()

bool	Compress (bool bForce=true)

void	Interrupt ()

bool	Open (const DatabaseSettings &db)

void	BeginTransaction ()

virtual bool	CommitTransaction ()

void	RollbackTransaction ()

bool	InTransaction ()

void	CopyDB (const std::string &latestDb)

void	DropAnalytics ()

std::string	PrepareSQL (std::string strStmt,...) const

std::string	GetSingleValue (const std::string &strTable, const std::string &strColumn, const std::string &strWhereClause=std::string(), const std::string &strOrderBy=std::string())
	Get a single value from a table. More...

std::string	GetSingleValue (const std::string &query)

std::string	GetSingleValue (const std::string &query, std::unique_ptr< dbiplus::Dataset > &ds)
	Get a single value from a query on a dataset. More...

bool	DeleteValues (const std::string &strTable, const Filter &filter=Filter())
	Delete values from a table. More...

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. More...

bool	ResultQuery (const std::string &strQuery)
	Execute a query that returns a result. More...

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! More...

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. More...

bool	QueueInsertQuery (const std::string &strQuery)
	Put an INSERT or REPLACE query in the queue. More...

bool	CommitInsertQueries ()
	Commit all queries in the queue. More...

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)

bool	Connect (const std::string &dbName, const DatabaseSettings &db, bool create)

Additional Inherited Members
Public Types inherited from CDatabase
typedef struct CDatabase::DatasetFieldInfo	DatasetFieldInfo

Protected Member Functions inherited from CDatabase
void	Split (const std::string &strFileNameAndPath, std::string &strPath, std::string &strFileName)

bool	CreateDatabase ()
	Create database tables and analytics as needed. Calls CreateTables() and CreateAnalytics() on child classes. More...

int	GetDBVersion ()

bool	BuildSQL (const std::string &strQuery, const Filter &filter, std::string &strSQL)

Protected Attributes inherited from CDatabase
bool	m_sqlite
	whether we use sqlite (defaults to true) More...

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

Detailed Description

The PVR database

Constructor & Destructor Documentation

§ CPVRDatabase()

PVR::CPVRDatabase::CPVRDatabase ( void )

default

Create a new instance of the PVR database.

§ ~CPVRDatabase()

PVR::CPVRDatabase::~CPVRDatabase ( void )

overridedefault

Member Function Documentation

§ Close()

void CPVRDatabase::Close ( void )

overridevirtual

Close the database.

Reimplemented from CDatabase.

§ Delete() [1/3]

bool CPVRDatabase::Delete ( const CPVRClient & client )

Remove a client entry from the database.

Parameters

client The client to remove.

Returns: True if the client was removed, false otherwise.

§ Delete() [2/3]

bool CPVRDatabase::Delete ( const CPVRChannel & channel )

Remove a channel entry from the database.

Parameters

channel The channel to remove.

Returns: True if the channel was removed, false otherwise.

§ Delete() [3/3]

bool CPVRDatabase::Delete ( const CPVRChannelGroup & group )

Delete a channel group from the database.

Parameters

group The group to delete.

Returns: True if the group was deleted successfully, false otherwise.

§ DeleteChannelGroups()

bool CPVRDatabase::DeleteChannelGroups ( void )

Remove all channel groups from the database.

Returns: True if all channel groups were removed.

§ DeleteChannels()

bool CPVRDatabase::DeleteChannels ( void )

Remove all channels from the database.

Returns: True if all channels were removed, false otherwise.

§ DeleteClients()

bool CPVRDatabase::DeleteClients ( )

Remove all client entries from the database.

Returns: True if all client entries were removed, false otherwise.

§ Get() [1/3]

int CPVRDatabase::Get	(	CPVRChannelGroup &	results,
		bool	bCompressDB
	)

Get the list of channels from the database.

Parameters

results	The channel group to store the results in.
bCompressDB	Compress the DB after getting the list

Returns: The amount of channels that were added.

§ Get() [2/3]

bool CPVRDatabase::Get ( CPVRChannelGroups & results )

Get the channel groups.

Parameters

results The container to store the results in.

Returns: True if the list was fetched successfully, false otherwise.

§ Get() [3/3]

int CPVRDatabase::Get	(	CPVRChannelGroup &	group,
		const CPVRChannelGroup &	allGroup
	)

Add the group members to a group.

Parameters

group	The group to get the channels for.
allGroup	The "all channels group" matching param group's 'IsRadio' property.

Returns: The amount of channels that were added.

§ GetBaseDBName()

const char* PVR::CPVRDatabase::GetBaseDBName ( void ) const

inlineoverridevirtual

Get the default sqlite database filename.

Returns: The default filename.

Implements CDatabase.

§ GetPriority()

int CPVRDatabase::GetPriority ( const CPVRClient & client )

Get the priority for a given client from the database.

Parameters

client The client.

Returns: The priority.

§ GetSchemaVersion()

int PVR::CPVRDatabase::GetSchemaVersion ( void ) const

inlineoverridevirtual

Get the minimal database version that is required to operate correctly.

Returns: The minimal database version.

Implements CDatabase.

§ Open()

bool CPVRDatabase::Open ( )

overridevirtual

Open the database.

Returns: True if it was opened successfully, false otherwise.

Reimplemented from CDatabase.

§ Persist() [1/3]

bool CPVRDatabase::Persist ( const CPVRClient & client )

Add or update a client entry in the database.

Parameters

client The client to persist.

Returns: True when persisted, false otherwise.

§ Persist() [2/3]

bool CPVRDatabase::Persist	(	CPVRChannel &	channel,
		bool	bCommit
	)

Add or update a channel entry in the database.

Parameters

channel	The channel to persist.
bCommit	queue only or queue and commit

Returns: True when persisted or queued, false otherwise.

§ Persist() [3/3]

bool CPVRDatabase::Persist ( CPVRChannelGroup & group )

Add or update a channel group entry in the database.

Parameters

group The group to persist.

Returns: True if the group was persisted successfully, false otherwise.

§ ResetEPG()

bool CPVRDatabase::ResetEPG ( void )

Reset all epg ids to 0.

Returns: True when reset, false otherwise.

§ UpdateLastWatched() [1/2]

bool CPVRDatabase::UpdateLastWatched ( const CPVRChannel & channel )

Updates the last watched timestamp for the channel.

Parameters

channel the channel

Returns: whether the update was successful

§ UpdateLastWatched() [2/2]

bool CPVRDatabase::UpdateLastWatched ( const CPVRChannelGroup & group )

Updates the last watched timestamp for the channel group.

Parameters

group the group

Returns: whether the update was successful

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ CPVRDatabase()

§ ~CPVRDatabase()

Member Function Documentation

§ Close()

§ Delete() [1/3]

§ Delete() [2/3]

§ Delete() [3/3]

§ DeleteChannelGroups()

§ DeleteChannels()

§ DeleteClients()

§ Get() [1/3]

§ Get() [2/3]

§ Get() [3/3]

§ GetBaseDBName()

§ GetPriority()

§ GetSchemaVersion()

§ Open()

§ Persist() [1/3]

§ Persist() [2/3]

§ Persist() [3/3]

§ ResetEPG()

§ UpdateLastWatched() [1/2]

§ UpdateLastWatched() [2/2]