An extension to the class that defines the interface to the MIP SDK storage table used for caching.
More...
#include <src/api/mip/storage_table.h>
|
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 uint32_t | DeleteRange (const std::vector< std::string > &queryColumns, const std::vector< std::string > &queryValues, const std::vector< ColumnMatch > &relations)=0 |
| Delete a set of rows with values greater or lesser than a target value. Need to set storage table version on StorageSettings to be >= StorageTableVersion::Two.
|
|
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.
|
|
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.
|
|
An extension to the class that defines the interface to the MIP SDK storage table used for caching.
- Note
- To use the additional functionality of this class, the storage table version on StorageDelegate::StorageSettings must be >= StorageTableVersion::Two
Definition at line 143 of file storage_table.h.
◆ Delete()
virtual void StorageTable::Delete |
( |
const std::vector< std::string > & | queryColumns, |
|
|
const std::vector< std::string > & | queryValues ) |
|
pure virtualinherited |
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 . |
◆ DeleteRange()
virtual uint32_t StorageTableV2::DeleteRange |
( |
const std::vector< std::string > & | queryColumns, |
|
|
const std::vector< std::string > & | queryValues, |
|
|
const std::vector< ColumnMatch > & | relations ) |
|
pure virtual |
Delete a set of rows with values greater or lesser than a target value. Need to set storage table version on StorageSettings to be >= StorageTableVersion::Two.
- Parameters
-
queryColumns | Column names to determine the table rows to delete. |
queryValues | Column values which combine with a specific relation to get the delete set. Corresponding to the data in queryColumns |
relations | The relation to use to specify data. Corresponding to the data in queryValues |
- Returns
- Number of rows deleted
- Note
- Intended for use on ISO time values, where sorting alphabetically is equivalent to sorting chronologically.
- Warning
- Will not work on encrypted columns.
◆ Find()
virtual std::vector< std::vector< std::string > > StorageTable::Find |
( |
const std::vector< std::string > & | queryColumns, |
|
|
const std::vector< std::string > & | queryValues ) |
|
pure virtualinherited |
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 | ) |
|
|
inlinevirtualinherited |
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.
Definition at line 74 of file storage_table.h.
75 {
77 }
virtual void InsertOrReplace(const std::vector< std::string > &allColumnValues)=0
Adds a row to the table.
References StorageTable::InsertOrReplace().
◆ InsertOrReplace()
virtual void StorageTable::InsertOrReplace |
( |
const std::vector< std::string > & | allColumnValues | ) |
|
|
pure virtualinherited |
Adds a row to the table.
- Parameters
-
allColumnValues | All column values in sequence as represented in storage table. |
Referenced by StorageTable::Insert().
◆ List()
virtual std::vector< std::vector< std::string > > StorageTable::List |
( |
| ) |
|
|
pure virtualinherited |
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 virtualinherited |
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: