StrToTuple (MDX)
Returns the tuple specified by a Multidimensional Expressions (MDX)–formatted string.
Syntax
StrToTuple(Tuple_Specification [,CONSTRAINED] )
Arguments
- Tuple_Specification
A valid string expression specifying, directly or indirectly, a tuple.
Remarks
The StrToTuple function returns the specified set. The StrToTuple function is typically used with user-defined functions to return a tuple specification from an external function back to an MDX statement.
When the CONSTRAINED flag is used, the tuple specification must contain qualified or unqualified member names. This flag is used to reduce the risk of injection attacks via the specified string. If a string is provided that is not directly resolvable to qualified or unqualified member names, the following error appears: "The restrictions imposed by the CONSTRAINED flag in the STRTOTUPLE function were violated."
When the CONSTRAINED flag is not used, the specified tuple can resolve to a valid MDX expression that returns a tuple.
Examples
The following example returns the Reseller Sales Amount measure for the Bayern member for calendar year 2004. The tuple specification that is provided contains a valid MDX tuple expression.
SELECT StrToTuple ('([Geography].[State-Province].[Bayern],[Date].[Calendar Year].[CY 2004])')
ON 0
FROM [Adventure Works]
The following example returns the Reseller Sales Amount measure for the Bayern member for calendar year 2004. The tuple specification that is provided contains qualified member names, as required by the CONSTRAINED flag.
SELECT StrToTuple ('([Geography].[State-Province].[Bayern],[Date].[Calendar Year].[CY 2004])', CONSTRAINED)
ON 0
FROM [Adventure Works]
The following example returns the Reseller Sales Amount measure for the Bayern member for calendar year 2004. The tuple specification that is provided contains a valid MDX tuple expression.
SELECT StrToTuple ('([Geography].[State-Province].[Bayern],[Date].[Calendar Year].LastChild)')
ON 0
FROM [Adventure Works]
The following example returns an error due to the CONSTRAINED flag. While the tuple specification provided contains a valid MDX tuple expression, the CONSTRAINED flag requires qualified or unqualified member names in the tuple specification.
SELECT StrToTuple ('([Geography].[State-Province].[Bayern],[Date].[Calendar Year].LastChild)', CONSTRAINED)
ON 0
FROM [Adventure Works]