A class that defines the interface to the MIP SDK storage table used for caching.
More...
#include <storage_table.h>
|
virtual void | Insert (const std::vector< std::string > &allColumnValues) |
| Adds a row to the table.
|
|
virtual void | InsertOrReplace (const std::vector< std::string > &allColumnValues)=0 |
| Adds a row to the table.
|
|
virtual std::vector< std::vector< std::string > > | List ()=0 |
| List all the rows in the table.
|
|
virtual void | Update (const std::vector< std::string > &updateColumns, const std::vector< std::string > &updateValues, const std::vector< std::string > &queryColumns, const std::vector< std::string > &queryValues)=0 |
| Update a set of rows within the table.
|
|
virtual void | Delete (const std::vector< std::string > &queryColumns, const std::vector< std::string > &queryValues)=0 |
| Delete a set of rows specified by queryColumns and queryValues.
|
|
virtual std::vector< std::vector< std::string > > | Find (const std::vector< std::string > &queryColumns, const std::vector< std::string > &queryValues)=0 |
| Find a set of rows specified by queryColumns and queryValues . This method can return multiple rows based on the filter.
|
|
A class that defines the interface to the MIP SDK storage table used for caching.
◆ Delete()
virtual void StorageTable::Delete |
( |
const std::vector< std::string > & | queryColumns, |
|
|
const std::vector< std::string > & | queryValues ) |
|
pure virtual |
Delete a set of rows specified by queryColumns and queryValues.
- Parameters
-
queryColumns | List of column names that identify the table rows to delete. |
queryValues | List of column values corresponding to queryColumns . |
◆ Find()
virtual std::vector< std::vector< std::string > > StorageTable::Find |
( |
const std::vector< std::string > & | queryColumns, |
|
|
const std::vector< std::string > & | queryValues ) |
|
pure virtual |
Find a set of rows specified by queryColumns
and queryValues
. This method can return multiple rows based on the filter.
- Parameters
-
queryColumns | List of column names that identify the table rows to find. |
queryValues | List of column values corresponding to queryColumns . |
- Returns
- List of all rows where each row is a list containing column values
◆ Insert()
virtual void StorageTable::Insert |
( |
const std::vector< std::string > & | allColumnValues | ) |
|
|
inlinevirtual |
Adds a row to the table.
- Parameters
-
allColumnValues | All column values in sequence as represented in storage table. |
- Deprecated
- This method will soon be deprecated in favor of InsertOrReplace. If the new version has been implemented, there is no need to implement this version.
◆ InsertOrReplace()
virtual void StorageTable::InsertOrReplace |
( |
const std::vector< std::string > & | allColumnValues | ) |
|
|
pure virtual |
Adds a row to the table.
- Parameters
-
allColumnValues | All column values in sequence as represented in storage table. |
◆ List()
virtual std::vector< std::vector< std::string > > StorageTable::List |
( |
| ) |
|
|
pure virtual |
List all the rows in the table.
- Returns
- List of all rows where each row is a vector of column values
◆ Update()
virtual void StorageTable::Update |
( |
const std::vector< std::string > & | updateColumns, |
|
|
const std::vector< std::string > & | updateValues, |
|
|
const std::vector< std::string > & | queryColumns, |
|
|
const std::vector< std::string > & | queryValues ) |
|
pure virtual |
Update a set of rows within the table.
- Parameters
-
updateColumns | List of column names that define the new row data. |
updateValues | List of column values corresponding to updateColumns . |
queryColumns | List of column names that identify the table rows to update. |
queryValues | List of column values corresponding to queryColumns . |
The documentation for this class was generated from the following file: