Akonadi

Functions
bool	insert (Part part, qint64 insertId=nullptr)

bool	remove (Part *part)

bool	remove (const QString &column, const QVariant &value)

QByteArray	translateData (const QByteArray &data, Part::Storage storageType)

QByteArray	translateData (const Part &part)

bool	truncate (Part &part)

void	update (Part *part, const QByteArray &data, qint64 dataSize)

bool	verify (Part &part)

Detailed Description

Helper methods that store data in a file instead of the database.

Todo:: Use exceptions for error handling in all these methods. Requires that all callers can handle that first though.

bool Akonadi::Server::PartHelper::insert	(	Part *	part,
		qint64 *	insertId = `nullptr`
	)

Adds a new part to the database and if necessary to the filesystem.

part must not be in the database yet (ie. valid() == false) and must have a data size set.

Definition at line 72 of file parthelper.cpp.

bool Akonadi::Server::PartHelper::remove ( Part * part )

Deletes part from the database and also removes existing filesystem data if needed.

Definition at line 104 of file parthelper.cpp.

bool Akonadi::Server::PartHelper::remove	(	const QString &	column,
		const QVariant &	value
	)

Deletes all parts which match the given constraint, including all corresponding filesystem data.

Definition at line 116 of file parthelper.cpp.

QByteArray Akonadi::Server::PartHelper::translateData	(	const QByteArray &	data,
		Part::Storage	storageType
	)

Returns the payload data.

Definition at line 136 of file parthelper.cpp.

QByteArray Akonadi::Server::PartHelper::translateData ( const Part & part )

Convenience overload of the above.

Definition at line 161 of file parthelper.cpp.

bool Akonadi::Server::PartHelper::truncate ( Part & part )

Truncate the payload of part and update filesystem/database accordingly.

This is more efficient than using update since it does not require the data to be loaded.

Definition at line 166 of file parthelper.cpp.

void Akonadi::Server::PartHelper::update	(	Part *	part,
		const QByteArray &	data,
		qint64	dataSize
	)

Update payload of an existing part part to data and size dataSize.

Automatically decides whether or not the data should be stored in the database or the file system.

Exceptions

PartHelperException if file operations failed

Definition at line 36 of file parthelper.cpp.

bool Akonadi::Server::PartHelper::verify ( Part & part )

Verifies and if necessary fixes the external reference of this part.

Definition at line 178 of file parthelper.cpp.

KDE's Doxygen guidelines are available online.