StorageDelegate Class Reference

A class that defines the interface to the MIP SDK storage for caching. More...

#include <storage_delegate.h>

Classes
class	StorageSettings
	Settings used by StorageDelegate. More...

Public Member Functions
virtual mip::StorageTableResult	CreateStorageTable (const std::string &path, const MipComponent mipComponent, const std::string &tableName, const std::vector< std::string > &allColumns, const std::vector< std::string > &encryptedColumns, const std::vector< std::string > &keyColumns) const =0
	Creates an instance of a storage table that MIP uses for caching. If a table already exists & schema doesnt match with allColumns , implementatiion should drop the table and re-create new one.
virtual StorageSettings	GetSettings () const =0
	Gets settings used by StorageDelegate.

Detailed Description

A class that defines the interface to the MIP SDK storage for caching.

Member Function Documentation

CreateStorageTable()

virtual mip::StorageTableResult StorageDelegate::CreateStorageTable ( const std::string & path, const MipComponent mipComponent, const std::string & tableName, const std::vector< std::string > & allColumns, const std::vector< std::string > & encryptedColumns, const std::vector< std::string > & keyColumns ) const

pure virtual

Creates an instance of a storage table that MIP uses for caching. If a table already exists & schema doesnt match with allColumns , implementatiion should drop the table and re-create new one.

Parameters

path	Default path for mip storage. Will end in file extension returned from StorageSettings::OnDiskExtension()
mipComponent	MipComponent associated with this table.
tableName	Name of the table to create.
allColumns	All columns represented in the table.
encryptedColumns	Represents the set of columns within allColumns that need to be encrypted. This argument is only populated if CacheStorageType (configured via the profile settings) is not OnDiskEncrypted, otherwise the MIP SDK will internally encrypt the column data for these columns and modify their name with an 'encrypt_' prefix.
keyColumns	Key columns used to identify unique table entries.

Returns

A delegate response which either contains an instance of StorageTable or an exception.

GetSettings()

virtual StorageSettings StorageDelegate::GetSettings ( ) const

pure virtual

Gets settings used by StorageDelegate.

Returns

settings used by StorageDelegate.

---

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

• /home/mbaldwin/docs/mip-sdk-for-cpp/src/api/mip/storage_delegate.h