2.4.162 BrtBeginPCDSDTCSet

The BRTBeginPCDSDTCSet record specifies the properties of a tuple cache set, as specified in section 2.2.5.2.11, and specifies the beginning of a collection of records as defined by the PivotCache Definition (section 2.1.7.38) part ABNF. The collection specifies a tuple cache set in the tuple cache. The collection can include the PCDSDTCEMEMBERSSORTBY collection (defined in section 2.1.7.38) to specify the tuple cache entries used to sort the tuple cache set. The PCDSDTCEMEMBERSSORTBY collection (defined in section 2.1.7.38) is present when fLoadSortTuple is 1.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

cTuples

iRankMax

ssoType

A

B

reserved

irstDef (variable)

...

cTuples (4 bytes): An unsigned integer that specifies the number of OLAP tuples in the tuple cache set. This value MUST be less than 0x80000000, or MUST be 0xFFFFFFFF when the number of OLAP tuples in the tuple cache set is unknown.

iRankMax (4 bytes): An unsigned integer that specifies the number of BrtBeginPCDSDTCEMembers collections (section 2.4.157) of tuple cache entries that this tuple cache set currently contains. This value MUST be greater than 0x00000000 and less than or equal to 0x00100000. This value MUST be less than or equal to cTuples. This value MUST be ignored if fQueryFailed is 1.

ssoType (4 bytes): An SdSetSortOrder (section 2.5.132) that specifies the sort order (2) of the tuple cache entries in the tuple cache set. If this field is equal to SSOASC or SSODESC, the tuples which specify the sort order (2) are specified by the sequence of records that conforms to the PCDSDTCEMEMBERSSORTBY rule (defined in section 2.1.7.38) following this record in the sequence of records that conforms to the PCDSDTCSET rule (defined in section 2.1.7.38).

A - fQueryFailed (1 bit): A bit that specifies whether the querying on this tuple cache set failed. A value of 1 specifies that MDX query execution has not finished successfully.

B - fLoadSortTuple (1 bit):  A bit that specifies whether tuple cache entries used to sort the tuple cache set exist in the file. This value MUST be 1 if and only if ssoType is equal to SSOASC (0x00000001) or SSODESC (0x00000002).

reserved (6 bits): This value MUST be 0 and MUST be ignored.

irstDef (variable): An XLWideString (section 2.5.169) that specifies the MDX expression that was used to evaluate this tuple cache set. The length of this string MUST be less than 65,536 characters.