Microsoft Information Protection SDK - C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
StorageTableV2 Class Referenceabstract

An extension to the class that defines the interface to the MIP SDK storage table used for caching. More...

#include <storage_table.h>

Inheritance diagram for StorageTableV2:
StorageTable

Public Member Functions

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.
 
- Public Member Functions inherited from StorageTable
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.
 

Detailed Description

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

Member Function Documentation

◆ 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
queryColumnsColumn names to determine the table rows to delete.
queryValuesColumn values which combine with a specific relation to get the delete set. Corresponding to the data in queryColumns
relationsThe 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.

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