strus::StorageTransaction Class Reference

Object representing a transaction of the storage. More...

#include <bindingObjects.hpp>

Public Member Functions
	~StorageTransaction ()
	Destructor. More...
void	insertDocument (const String &docid, const Document &doc)
	Prepare the inserting a document into the storage. More...
void	deleteDocument (const String &docid)
	Prepare the deletion of a document from the storage. More...
void	deleteUserAccessRights (const String &username)
	Prepare the deletion of all document access rights of a user. More...
void	commit ()
	Commit all insert or delete or user access right change statements of this transaction. More...
void	rollback ()
	Rollback all insert or delete or user access right change statements of this transaction. More...

Friends
class	StorageClient
class	Query
class	QueryEval

Detailed Description

Object representing a transaction of the storage.

Remarks

The only way to construct a storage transaction instance is to call StorageClient::createTransaction()

Constructor & Destructor Documentation

strus::StorageTransaction::~StorageTransaction ( )

inline

Destructor.

Member Function Documentation

void strus::StorageTransaction::commit

(

)

Commit all insert or delete or user access right change statements of this transaction.

void strus::StorageTransaction::deleteDocument

(

const String &

docid

)

Prepare the deletion of a document from the storage.

Parameters

[in]

docid

the identifier of the document to delete

Remarks

The document is physically deleted with the call of 'commit()'

void strus::StorageTransaction::deleteUserAccessRights

(

const String &

username

)

Prepare the deletion of all document access rights of a user.

Parameters

[in]

username

the name of the user to delete all access rights (in the local collection)

Remarks

The user access rights are changed accordingly with the next implicit or explicit call of 'flush'

void strus::StorageTransaction::insertDocument	(	const String &	docid,
		const Document &	doc
	)

Prepare the inserting a document into the storage.

Parameters

[in]	docid	the identifier of the document to insert
[in]	doc	the structure of the document to insert

Remarks

The document is physically inserted with the call of 'commit()'

void strus::StorageTransaction::rollback

(

)

Rollback all insert or delete or user access right change statements of this transaction.

Friends And Related Function Documentation

friend class Query

friend

friend class QueryEval

friend

friend class StorageClient

friend

---

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

• /home/patrick/Projects/github/strusBindings/include/strus/bindingObjects.hpp