2.4.168 BrtBeginPivotCacheDef
The BrtBeginPivotCacheDef record specifies properties of a PivotCache (section 2.2.5.2) and specifies the beginning of a collection of records as defined by the PivotCache Definition (section 2.1.7.38) part ABNF. The collection of records specifies a PivotCache.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
bVerCacheLastRefresh |
bVerCacheRefreshableMin |
bVerCacheCreated |
A |
B |
C |
D |
E |
F |
G |
H |
|||||||||||||||||||||
|
citmGhostMax |
|||||||||||||||||||||||||||||||
|
xnumRefreshedDate |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
I |
J |
K |
L |
M |
cRecords |
||||||||||||||||||||||||||
|
... |
stRefreshedWho (variable) |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
stRelIDRecords (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
unused (optional) |
|||||||||||||||||||||||||||||||
bVerCacheLastRefresh (1 byte): A DataFunctionalityLevel (section 2.5.29) that specifies the data functionality level (section 2.2.5.1) that the PivotCache was last refreshed with.
-
This value MUST NOT be less than bVerCacheRefreshableMin value.
bVerCacheRefreshableMin (1 byte): A DataFunctionalityLevel that specifies the lowest data functionality level that the application is required to support to refresh the PivotCache. For more details, see section 2.2.5.1.
bVerCacheCreated (1 byte): A DataFunctionalityLevel that specifies the data functionality level that the PivotCache was created with. For more details, see section 2.2.5.1.
A - fSaveData (1 bit): A bit that specifies whether the cache records (section 2.2.5.2.10) exist. This value MUST be equal to 0 for OLAP PivotCaches.
B - fInvalid (1 bit): A bit that specifies whether the cache records of this PivotCache are in an invalid state, in which case they MUST be ignored.
C - fRefreshOnLoad (1 bit): A bit that specifies whether the PivotCache is refreshed on load.
D - fOptimizeCache (1 bit): A bit that specifies whether the application applies optimizations to the PivotCache to reduce memory usage. This value MUST be equal to 0 for non-external and non-ODBC source data (section 2.2.5.2.1).
E - fEnableRefresh (1 bit): A bit that specifies whether refresh of the PivotCache is enabled.
F - fBackgroundQuery (1 bit): A bit that specifies whether to refresh this PivotCache asynchronously. This value MUST be equal to 0 if the iSrcType field in the associated BrtBeginPCDSource (section 2.4.166) record is not equal to 0x00000001.
G - fUpgradeOnRefresh (1 bit): A bit that specifies whether the data functionality level of this PivotCache has to be upgraded to 3 during the next refresh. This value MUST be 0 if the data functionality level of this PivotCache is greater than or equal to 3.
H - fSheetData (1 bit): A bit that specifies whether the PivotCache is used to store information for cube functions. This value MUST be equal to 0 for non-OLAP PivotCaches. If the value is equal to 1, this PivotCache MUST NOT be associated with any PivotTable as specified in section 2.2.5.3.1.
citmGhostMax (4 bytes): A signed integer that specifies the number of unused cache items (section 2.2.5.2.3) to allow before discarding unused cache items on the next refresh. This value MUST be greater than -2 and less than 1048577. If this value is equal to 0, all unused cache items are discarded on the next refresh. If this value is equal to -1, the number of unused cache items retained by the application is optimized to balance memory usage on the system and future usage of cache items.
xnumRefreshedDate (8 bytes): A DateAsXnum (section 2.5.30) that specifies the date when the PivotCache was last refreshed.
I - fLoadRefreshedWho (1 bit): A bit that specifies whether the stRefreshedWho field exists.
J - fLoadRelIDRecords (1 bit): A bit that specifies whether the stRelIDRecords field exists. This value MUST be equal to 1 if fSaveData is equal to 1 and fInvalid is equal to 0.
K - fSupportSubquery (1 bit): A bit that specifies whether the source data of the PivotCache supports OLAP subselect.
L - fSupportAttribDrill (1 bit): A bit that specifies whether the source data of the PivotCache supports attribute drilldown.
M - reserved (4 bits): This value MUST be 0, and MUST be ignored.
cRecords (4 bytes): An unsigned integer that specifies the number of cache records in the PivotCache. If fSaveData is equal to 0, this value is undefined and MUST be ignored.
stRefreshedWho (variable): An optional XLWideString (section 2.5.169) that specifies the name of the user who last refreshed the PivotCache. This value MUST exist if and only if fLoadRefreshedWho is equal to 1. The length of this value MUST be less than 256 characters. The name is an application-specific setting that is not necessarily related to the User Names (section 2.1.7.55) part ABNF.
stRelIDRecords (variable): An optional RelID that specifies the unique identifier that corresponds to the related PivotCache Records (section 2.1.7.39) part. This value MUST exist and MUST be non-empty if and only if fLoadRelIDRecords is equal to 1.
unused (4 bytes): This value is undefined and MUST be ignored. This field MUST exist if and only if fLoadRefreshedWho is equal to 0.