strus  0.17
Public Member Functions | List of all members
strus::StorageAlterMetaDataTableInterface Class Referenceabstract

Interface to declare changes in the meta data table structure of the storage. More...

#include <storageAlterMetaDataTableInterface.hpp>

Public Member Functions

virtual ~StorageAlterMetaDataTableInterface ()
 Destructor that is the doing the rollback too, if commit() was not called before. More...
 
virtual void addElement (const std::string &name, const std::string &datatype)=0
 Declare a new meta data element. More...
 
virtual void alterElement (const std::string &oldname, const std::string &name, const std::string &datatype)=0
 Declare a meta data element to be changed. More...
 
virtual void renameElement (const std::string &oldname, const std::string &name)=0
 Declare a meta data element to be renamed. More...
 
virtual void deleteElement (const std::string &name)=0
 Declare a meta data element to be deleted. More...
 
virtual void clearElement (const std::string &name)=0
 Declare a meta data element to be reset (all values are reinitialized with their default) More...
 
virtual bool commit ()=0
 Write the changes of the meta data table structure to the storage. More...
 
virtual void rollback ()=0
 Rollback of the meta data table changes, no changes made. More...
 

Detailed Description

Interface to declare changes in the meta data table structure of the storage.

Constructor & Destructor Documentation

virtual strus::StorageAlterMetaDataTableInterface::~StorageAlterMetaDataTableInterface ( )
inlinevirtual

Destructor that is the doing the rollback too, if commit() was not called before.

Member Function Documentation

virtual void strus::StorageAlterMetaDataTableInterface::addElement ( const std::string &  name,
const std::string &  datatype 
)
pure virtual

Declare a new meta data element.

Parameters
[in]namename of the element to add
[in]datatypetype of the element to add
virtual void strus::StorageAlterMetaDataTableInterface::alterElement ( const std::string &  oldname,
const std::string &  name,
const std::string &  datatype 
)
pure virtual

Declare a meta data element to be changed.

Parameters
[in]oldnameprevious name of the element
[in]namenew name of the element
[in]datatypenew type of the element
virtual void strus::StorageAlterMetaDataTableInterface::clearElement ( const std::string &  name)
pure virtual

Declare a meta data element to be reset (all values are reinitialized with their default)

Parameters
[in]namename of the element values to reset
virtual bool strus::StorageAlterMetaDataTableInterface::commit ( )
pure virtual

Write the changes of the meta data table structure to the storage.

virtual void strus::StorageAlterMetaDataTableInterface::deleteElement ( const std::string &  name)
pure virtual

Declare a meta data element to be deleted.

Parameters
[in]namename of the element to delete
virtual void strus::StorageAlterMetaDataTableInterface::renameElement ( const std::string &  oldname,
const std::string &  name 
)
pure virtual

Declare a meta data element to be renamed.

Parameters
[in]oldnameprevious name of the element
[in]namenew name of the element
virtual void strus::StorageAlterMetaDataTableInterface::rollback ( )
pure virtual

Rollback of the meta data table changes, no changes made.


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