CDatabase Class Reference

Provide interfaces such as opening the database and initializing the database. More...

#include <Database.h>

Inheritance diagram for CDatabase:

Collaboration diagram for CDatabase:

Signals
void	sigChanged ()

Public Member Functions
	CDatabase (QObject *parent=nullptr)
QSqlDatabase	GetDatabase () const
virtual bool	IsOpen () const
void	CloseDatabase ()
	Close database.
const CParameterDatabase *	GetParameter () const
const QString	GetError () const
Share an existing database
bool	SetDatabase (const CDatabase *db)
	Share an existing database.
bool	SetDatabase (const QSqlDatabase db, const CParameterDatabase *pPara)
	Share an existing database.
Open a new database
bool	OpenDatabase (const CParameterDatabase *pPara=nullptr, const QString &szConnectName=QString())
	Open a new database.
bool	OpenMySqlDatabase (const CParameterDatabase *pPara, const QString &szConnectName=QString())
bool	OpenODBCDatabase (const CParameterDatabase *pPara, const QString &szConnectName=QString())
bool	OpenSQLiteDatabase (const CParameterDatabase *pPara, const QString &szConnectionName=QString())
bool	OpenSQLiteDatabase (const QString &szFile, const QString &szConnectionName=QString())
Export and import operate
virtual bool	ExportToJsonFile (const QString &szFile)
virtual bool	ImportFromJsonFile (const QString &szFile)

Protected Member Functions
void	SetError (const QString &szErr=QString())
virtual bool	ExportToJson (QJsonObject &obj)
virtual bool	ImportFromJson (const QJsonObject &obj)
Initialize table
virtual bool	OnInitializeDatabase ()
	Initialize database.
virtual bool	OnInitializeSqliteDatabase ()
virtual bool	OnInitializeMySqlDatabase ()

Protected Attributes
QString	m_szConnectName
QString	m_MinVersion
const CParameterDatabase *	m_pPara

Private Attributes
QSqlDatabase	m_database
bool	m_bOwner
QString	m_szError

Detailed Description

Provide interfaces such as opening the database and initializing the database.

Definition at line 20 of file Database.h.

Constructor & Destructor Documentation

~CDatabase()

CDatabase::~CDatabase ( )

virtual

Definition at line 27 of file Database.cpp.

Member Function Documentation

CloseDatabase()

void CDatabase::CloseDatabase

(

)

Close database.

Note

It is only necessary to use it to close the database when using OpenDatabase.

Definition at line 321 of file Database.cpp.

ExportToJson()

bool CDatabase::ExportToJson ( QJsonObject & obj )

nodiscardprotectedvirtual

Definition at line 414 of file Database.cpp.

ExportToJsonFile()

bool CDatabase::ExportToJsonFile ( const QString & szFile )

nodiscardvirtual

Definition at line 334 of file Database.cpp.

GetDatabase()

QSqlDatabase CDatabase::GetDatabase ( ) const

nodiscard

Definition at line 49 of file Database.cpp.

GetError()

const QString CDatabase::GetError ( ) const

nodiscard

Definition at line 59 of file Database.cpp.

GetParameter()

const CParameterDatabase * CDatabase::GetParameter ( ) const

nodiscard

Definition at line 54 of file Database.cpp.

ImportFromJson()

bool CDatabase::ImportFromJson ( const QJsonObject & obj )

nodiscardprotectedvirtual

Definition at line 409 of file Database.cpp.

ImportFromJsonFile()

bool CDatabase::ImportFromJsonFile ( const QString & szFile )

nodiscardvirtual

Definition at line 369 of file Database.cpp.

IsOpen()

bool CDatabase::IsOpen ( ) const

nodiscardvirtual

Definition at line 316 of file Database.cpp.

OnInitializeDatabase()

bool CDatabase::OnInitializeDatabase ( )

nodiscardprotectedvirtual

Initialize database.

Returns

Reimplemented in CBookmarkDatabase, CDatabaseTree, CDatabaseUrl, CFavoriteDatabase, CHistoryDatabase, and CRecentDatabase.

Definition at line 288 of file Database.cpp.

OnInitializeMySqlDatabase()

bool CDatabase::OnInitializeMySqlDatabase ( )

nodiscardprotectedvirtual

Definition at line 311 of file Database.cpp.

OnInitializeSqliteDatabase()

bool CDatabase::OnInitializeSqliteDatabase ( )

nodiscardprotectedvirtual

Definition at line 306 of file Database.cpp.

OpenDatabase()

bool CDatabase::OpenDatabase ( const CParameterDatabase * pPara = nullptr, const QString & szConnectName = QString() )

nodiscard

Open a new database.

Parameters

pPara	nullptr, use sqlite database
szConnectName	connect name

Returns

• true: successfully
• false: failed

Definition at line 69 of file Database.cpp.

OpenMySqlDatabase()

bool CDatabase::OpenMySqlDatabase ( const CParameterDatabase * pPara, const QString & szConnectName = QString() )

nodiscard

Definition at line 163 of file Database.cpp.

OpenODBCDatabase()

bool CDatabase::OpenODBCDatabase ( const CParameterDatabase * pPara, const QString & szConnectName = QString() )

nodiscard

Definition at line 232 of file Database.cpp.

OpenSQLiteDatabase() [1/2]

bool CDatabase::OpenSQLiteDatabase ( const CParameterDatabase * pPara, const QString & szConnectionName = QString() )

nodiscard

Definition at line 113 of file Database.cpp.

OpenSQLiteDatabase() [2/2]

bool CDatabase::OpenSQLiteDatabase ( const QString & szFile, const QString & szConnectionName = QString() )

nodiscard

Definition at line 123 of file Database.cpp.

SetDatabase() [1/2]

bool CDatabase::SetDatabase ( const CDatabase * db )

nodiscard

Share an existing database.

Parameters

db

Definition at line 34 of file Database.cpp.

SetDatabase() [2/2]

bool CDatabase::SetDatabase ( const QSqlDatabase db, const CParameterDatabase * pPara )

nodiscard

Share an existing database.

Parameters

db
pPara

Definition at line 39 of file Database.cpp.

SetError()

void CDatabase::SetError ( const QString & szErr = QString() )

protected

Definition at line 64 of file Database.cpp.

Member Data Documentation

m_bOwner

bool CDatabase::m_bOwner

private

Definition at line 120 of file Database.h.

m_database

QSqlDatabase CDatabase::m_database

private

Definition at line 119 of file Database.h.

m_MinVersion

QString CDatabase::m_MinVersion

protected

Definition at line 115 of file Database.h.

m_pPara

const CParameterDatabase* CDatabase::m_pPara

protected

Definition at line 116 of file Database.h.

m_szConnectName

QString CDatabase::m_szConnectName

protected

Definition at line 114 of file Database.h.

m_szError

QString CDatabase::m_szError

private

Definition at line 121 of file Database.h.

---

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

• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Database/Database.h
• /home/runner/work/RabbitRemoteControl/RabbitRemoteControl/Src/Database/Database.cpp