StorageDelegate::StorageSettings Class Reference

Settings used by StorageDelegate. More...

#include <mip/storage_delegate.h>

Public Member Functions
	StorageSettings (bool isRemoteStorage, bool isInMemoryStorageSupported, const std::string &onDiskExtension=GetSqliteExtension(), StorageTableVersion storageTableVersion=StorageTableVersion::One)
	Interface for configuring the storage settings.
bool	IsRemoteStorage () const
	Gets whether remote storage is used or not.
bool	IsInMemoryStorageSupported () const
	Gets whether the delegate supports in-memory storage.
std::string	OnDiskExtension () const
	Gets the extension that the delegate will use when storing a table on disk.
unsigned int	GetStorageTableVersion () const
	Gets the version of the underlying storage tables that will be created by this StorageDelegate.
	~StorageSettings ()
	StorageSettings ()

Private Attributes
bool	mIsRemoteStorage
bool	mIsInMemoryStorageSupported
std::string	mOnDiskExtension
unsigned int	mStorageTableVersion

Detailed Description

Settings used by StorageDelegate.

Constructor & Destructor Documentation

StorageSettings() [1/2]

StorageDelegate::StorageSettings::StorageSettings ( bool isRemoteStorage, bool isInMemoryStorageSupported, const std::string & onDiskExtension = GetSqliteExtension(), StorageTableVersion storageTableVersion = StorageTableVersion::One )

inline

Interface for configuring the storage settings.

Parameters

isRemoteStore	represents if store is remote. This will be taken into account for internal encryption.
isInMemoryStorageSupported	Declares whether the delegate supports in-memory storage.
onDiskExtension	The file extension that will be used to store the data if it is needed. Should begin with ".".
storageTableVersion	The version of the storage table that will be created by this delegate. If this is greater than 1, a cast can be made in internal code.

~StorageSettings()

StorageDelegate::StorageSettings::~StorageSettings ( )

inline

StorageSettings() [2/2]

StorageDelegate::StorageSettings::StorageSettings ( )

inline

Member Function Documentation

GetStorageTableVersion()

unsigned int StorageDelegate::StorageSettings::GetStorageTableVersion ( ) const

inline

Gets the version of the underlying storage tables that will be created by this StorageDelegate.

Returns

The version of the StorageTables created

IsInMemoryStorageSupported()

bool StorageDelegate::StorageSettings::IsInMemoryStorageSupported ( ) const

inline

Gets whether the delegate supports in-memory storage.

Returns

true if the delegate supports in-memory storage.

IsRemoteStorage()

bool StorageDelegate::StorageSettings::IsRemoteStorage ( ) const

inline

Gets whether remote storage is used or not.

Returns

whether remote storage is used or not.

OnDiskExtension()

std::string StorageDelegate::StorageSettings::OnDiskExtension ( ) const

inline

Gets the extension that the delegate will use when storing a table on disk.

Returns

The extension that will be used. Default to ".sqlite3".

Note

Extension will have "." preceding it

Member Data Documentation

mIsInMemoryStorageSupported

bool StorageDelegate::StorageSettings::mIsInMemoryStorageSupported

private

mIsRemoteStorage

bool StorageDelegate::StorageSettings::mIsRemoteStorage

private

mOnDiskExtension

std::string StorageDelegate::StorageSettings::mOnDiskExtension

private

mStorageTableVersion

unsigned int StorageDelegate::StorageSettings::mStorageTableVersion

private

---

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

• src/api/mip/storage_delegate.h