Interacts with yatish tables in a MySQL/MariaDB database. More...

#include <yatishDBmysql.h>

Inheritance diagram for yatishDBmysql:

Collaboration diagram for yatishDBmysql:

Public Member Functions
	yatishDBmysql ()
	Mainly connects to the MySQL database specified in `yatish.auth` More...

	~yatishDBmysql ()

bool	IsOk ()

int	Commit ()
	Updates `slaveDB` with records of `masterDB` where the sync field is not `'S'`. More...

int	Upload ()
	Uploads `masterDB` into `slaveDB`. More...

int	Download ()
	Downloads `slaveDB` into `masterDB`. More...

Private Member Functions
bool	NewTables ()
	Creates the yatish tables. More...

bool	EmptySlaveTables ()
	Empties all yatish tables in `slaveDB`. More...

bool	EmptyMasterTables ()
	Empties all yatish tables in `masterDB`. More...

bool	OutdateMasterTables ()
	Sets the sync field to 'I' in all records of all yatish tables in `masterDB`. More...

bool	Delete ()
	Takes care of DELETEs in yatish tables. More...

bool	Insert ()
	Takes care of INSERTs in yatish tables with a single name column. More...

bool	InsertProject ()
	Takes care of INSERTs in yatish_project. More...

bool	InsertActivity ()
	Takes care of INSERTs in yatish_activity. More...

bool	InsertTimeslot ()
	Takes care of INSERTs in yatish_timeslot. More...

bool	Update ()
	Takes care of UPDATEs in yatish tables with a single name column. More...

bool	UpdateProject ()
	Takes care of UPDATEs in yatish_project. More...

bool	UpdateActivity ()
	Takes care of UPDATEs in yatish_activity. More...

bool	UpdateTimeslot ()
	Takes care of UPDATEs in yatish_timeslot. More...

bool	DownloadNames ()
	Downloads yatish tables with a single name column. More...

bool	DownloadProject ()
	Downloads yatish_project. More...

bool	DownloadActivity ()
	Downloads yatish_activity. More...

bool	DownloadTimeslot ()
	Download yatish_timeslot. More...

Private Attributes
int	errorCode

Static Private Attributes
static wxDatabase *	slaveDB = nullptr

Additional Inherited Members
Static Public Attributes inherited from yatishDB
static const char *	tableName []
	Must be defined in the same order as `enum tableID`. More...

Protected Member Functions inherited from yatishDB
wxDatabase *	GetDatabase (const wxString &)
	Sets up a (configuration) flux using its argument then calls `wxDatabase::GetDatabase()`. More...

bool	TablesOk (wxDatabase *)
	Returns `false` if any of the yatish table is missings. More...

Static Protected Attributes inherited from yatishDB
static wxDatabase *	masterDB = nullptr

Detailed Description

Interacts with yatish tables in a MySQL/MariaDB database.

See also: yatishDBsqlite

Definition at line 19 of file yatishDBmysql.h.

Constructor & Destructor Documentation

◆ yatishDBmysql()

yatishDBmysql::yatishDBmysql ( )

Mainly connects to the MySQL database specified in yatish.auth

(initializing private member slaveDB).

Todo:: optimize Download() & Upload() (wxPreparedStatement?)

Definition at line 27 of file yatishDBmysql.cpp.

◆ ~yatishDBmysql()

yatishDBmysql::~yatishDBmysql ( )

Definition at line 116 of file yatishDBmysql.cpp.

Member Function Documentation

◆ Commit()

int yatishDBmysql::Commit ( )

Updates slaveDB with records of masterDB where the sync field is not 'S'.

Also sets the (local) sync field to 'S' when (remote) data were updated with no error.

Returns: wxDatabase error code if something went wrong (otherwise 0)

Definition at line 127 of file yatishDBmysql.cpp.

◆ Delete()

bool yatishDBmysql::Delete ( )

private

Takes care of DELETEs in yatish tables.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

N.B. We rely on the fact that the id of a record is the same in both RDBMS (cf. Insert()).

Definition at line 221 of file yatishDBmysql.cpp.

◆ Download()

int yatishDBmysql::Download ( )

Downloads slaveDB into masterDB.

Warning! Former data in masterDB (if any) are erased.

Returns: wxDatabase error code if something went wrong (otherwise 0)

Definition at line 151 of file yatishDBmysql.cpp.

◆ DownloadActivity()

bool yatishDBmysql::DownloadActivity ( )

private

Downloads yatish_activity.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 457 of file yatishDBmysql.cpp.

◆ DownloadNames()

bool yatishDBmysql::DownloadNames ( )

private

Downloads yatish tables with a single name column.

The id is also copied (we do not use local AUTO_INCREMENT). The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

N.B. This function assumes tableName was defined with "simple" tables first.

See also: DownloadProject() DownloadActivity() DownloadTimeslot()

Definition at line 285 of file yatishDBmysql.cpp.

◆ DownloadProject()

bool yatishDBmysql::DownloadProject ( )

private

Downloads yatish_project.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 374 of file yatishDBmysql.cpp.

◆ DownloadTimeslot()

bool yatishDBmysql::DownloadTimeslot ( )

private

Download yatish_timeslot.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 542 of file yatishDBmysql.cpp.

◆ EmptyMasterTables()

bool yatishDBmysql::EmptyMasterTables ( )

private

Empties all yatish tables in masterDB.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 181 of file yatishDBmysql.cpp.

◆ EmptySlaveTables()

bool yatishDBmysql::EmptySlaveTables ( )

private

Empties all yatish tables in slaveDB.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 162 of file yatishDBmysql.cpp.

◆ Insert()

bool yatishDBmysql::Insert ( )

private

Takes care of INSERTs in yatish tables with a single name column.

The id is also copied (we do not use remote AUTO_INCREMENT). The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

N.B. This function assumes tableName was defined with "simple" tables first.

See also: InsertProject() InsertActivity() InsertTimeslot()

Definition at line 252 of file yatishDBmysql.cpp.

◆ InsertActivity()

bool yatishDBmysql::InsertActivity ( )

private

Takes care of INSERTs in yatish_activity.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 428 of file yatishDBmysql.cpp.

◆ InsertProject()

bool yatishDBmysql::InsertProject ( )

private

Takes care of INSERTs in yatish_project.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 346 of file yatishDBmysql.cpp.

◆ InsertTimeslot()

bool yatishDBmysql::InsertTimeslot ( )

private

Takes care of INSERTs in yatish_timeslot.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 513 of file yatishDBmysql.cpp.

◆ IsOk()

bool yatishDBmysql::IsOk ( )

inline

Definition at line 23 of file yatishDBmysql.h.

◆ NewTables()

bool yatishDBmysql::NewTables ( )

private

Creates the yatish tables.

Warning! If any of the tables was already there, it is emptied.

Returns: false if something went wrong

Definition at line 50 of file yatishDBmysql.cpp.

◆ OutdateMasterTables()

bool yatishDBmysql::OutdateMasterTables ( )

private

Sets the sync field to 'I' in all records of all yatish tables in masterDB.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 200 of file yatishDBmysql.cpp.

◆ Update()

bool yatishDBmysql::Update ( )

private

Takes care of UPDATEs in yatish tables with a single name column.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

N.B. This function assumes tableName was defined with "simple" tables first.

N.B. We rely on the fact that the id of a record is the same in both RDBMS (cf. Insert()).

See also: UpdateProject() UpdateActivity() UpdateTimeslot()

Definition at line 317 of file yatishDBmysql.cpp.

◆ UpdateActivity()

bool yatishDBmysql::UpdateActivity ( )

private

Takes care of UPDATEs in yatish_activity.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 484 of file yatishDBmysql.cpp.

◆ UpdateProject()

bool yatishDBmysql::UpdateProject ( )

private

Takes care of UPDATEs in yatish_project.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 400 of file yatishDBmysql.cpp.

◆ UpdateTimeslot()

bool yatishDBmysql::UpdateTimeslot ( )

private

Takes care of UPDATEs in yatish_timeslot.

The error code from the wxDatabase library (if any) is stored in errorCode (private member).

Returns: false if something went wrong

Definition at line 569 of file yatishDBmysql.cpp.

◆ Upload()

int yatishDBmysql::Upload ( )

Uploads masterDB into slaveDB.

Warning! Former data in slaveDB (if any) are erased.

Returns: wxDatabase error code if something went wrong (otherwise 0)

Definition at line 139 of file yatishDBmysql.cpp.

Member Data Documentation

◆ errorCode

int yatishDBmysql::errorCode

private

Definition at line 29 of file yatishDBmysql.h.

◆ slaveDB

wxDatabase * yatishDBmysql::slaveDB = nullptr

staticprivate

Definition at line 28 of file yatishDBmysql.h.

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

/home/nicolas/sources/yatish/yatishDBmysql.h
/home/nicolas/sources/yatish/yatishDBmysql.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ yatishDBmysql()

◆ ~yatishDBmysql()

Member Function Documentation

◆ Commit()

◆ Delete()

◆ Download()

◆ DownloadActivity()

◆ DownloadNames()

◆ DownloadProject()

◆ DownloadTimeslot()

◆ EmptyMasterTables()

◆ EmptySlaveTables()

◆ Insert()

◆ InsertActivity()

◆ InsertProject()

◆ InsertTimeslot()

◆ IsOk()

◆ NewTables()

◆ OutdateMasterTables()

◆ Update()

◆ UpdateActivity()

◆ UpdateProject()

◆ UpdateTimeslot()

◆ Upload()

Member Data Documentation

◆ errorCode

◆ slaveDB