strusPython  0.14
Public Member Functions | Friends | List of all members
strus::StorageClient Class Reference

Object representing a client connection to the storage. More...

#include <bindingObjects.hpp>

Public Member Functions

 StorageClient (const StorageClient &o)
 Copy constructor. More...
 
 ~StorageClient ()
 Destructor. More...
 
Index nofDocumentsInserted () const
 Get the number of documents inserted into the storage return the total number of documents. More...
 
StorageTransaction createTransaction () const
 Create a transaction return the transaction object created. More...
 
StatisticsIterator createInitStatisticsIterator (bool sign) const
 Create an iterator on the storage statistics (total value) to distribute for initialization/deinitialization. More...
 
StatisticsIterator createUpdateStatisticsIterator () const
 Create an iterator on the storage statistics (relative value) to distribute after storage updates return the statistics message iterator object created. More...
 
DocumentBrowser createDocumentBrowser ()
 Create a document browser instance. More...
 
void close ()
 Close of the storage client. More...
 

Friends

class Context
 
class Query
 
class QueryEval
 

Detailed Description

Object representing a client connection to the storage.

Remarks
The only way to construct a storage client instance is to call Context::createStorageClient(const std::string&)

Constructor & Destructor Documentation

strus::StorageClient::StorageClient ( const StorageClient o)

Copy constructor.

strus::StorageClient::~StorageClient ( )
inline

Destructor.

Member Function Documentation

void strus::StorageClient::close ( )

Close of the storage client.

DocumentBrowser strus::StorageClient::createDocumentBrowser ( )

Create a document browser instance.

StatisticsIterator strus::StorageClient::createInitStatisticsIterator ( bool  sign) const

Create an iterator on the storage statistics (total value) to distribute for initialization/deinitialization.

Parameters
[in]signtrue = registration, false = deregistration return the statistics iterator object created
StorageTransaction strus::StorageClient::createTransaction ( ) const

Create a transaction return the transaction object created.

StatisticsIterator strus::StorageClient::createUpdateStatisticsIterator ( ) const

Create an iterator on the storage statistics (relative value) to distribute after storage updates return the statistics message iterator object created.

Index strus::StorageClient::nofDocumentsInserted ( ) const

Get the number of documents inserted into the storage return the total number of documents.

Friends And Related Function Documentation

friend class Context
friend
friend class Query
friend
friend class QueryEval
friend

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