StorageDelegate::StorageSettings Class Reference

Settings used by StorageDelegate. More...

#include <src/api/mip/storage_delegate.h>

Public Member Functions
bool	IsInMemoryStorageSupported () const
	Gets whether the delegate supports in-memory storage.
bool	IsRemoteStorage () const
	Gets whether remote storage is used or not.
std::string	OnDiskExtension () const
	Gets the extension that the delegate will use when storing a table on disk.
	StorageSettings (bool isRemoteStorage, bool isInMemoryStorageSupported, const std::string &onDiskExtension=GetSqliteExtension())
	Interface for configuring the storage settings.

Detailed Description

Settings used by StorageDelegate.

Definition at line 90 of file storage_delegate.h.

Constructor & Destructor Documentation

StorageSettings()

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

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 ".".

Definition at line 99 of file storage_delegate.h.

        : mIsRemoteStorage(isRemoteStorage),
          mIsInMemoryStorageSupported(isInMemoryStorageSupported),
          mOnDiskExtension(onDiskExtension) {}

Member Function Documentation

IsInMemoryStorageSupported()

bool StorageDelegate::StorageSettings::IsInMemoryStorageSupported ( ) const

inline

Gets whether the delegate supports in-memory storage.

Returns

true if the delegate supports in-memory storage.

Definition at line 119 of file storage_delegate.h.

{ return mIsInMemoryStorageSupported; }

IsRemoteStorage()

bool StorageDelegate::StorageSettings::IsRemoteStorage ( ) const

inline

Gets whether remote storage is used or not.

Returns

whether remote storage is used or not.

Definition at line 112 of file storage_delegate.h.

{ return mIsRemoteStorage; }

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

Definition at line 128 of file storage_delegate.h.

{ return mOnDiskExtension; }

---

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

• src/api/mip/storage_delegate.h