MDSCHEMA_ACTIONS Rowset

 

Applies To: SQL Server 2016 Preview

Describes the actions that may be available to the client application.

The MDSCHEMA_ACTIONS rowset contains the following columns.

Column nameType indicatorLengthDescription
CATALOG_NAMEDBTYPE_WSTRThe name of the database.
SCHEMA_NAMEDBTYPE_WSTRNot supported. Always contains VT_NULL.
CUBE_NAMEDBTYPE_WSTRThe name of the cube to which this action belongs.
ACTION_NAMEDBTYPE_WSTRThe name of this action.
ACTION_TYPEDBTYPE_I4A bitmap that is used to specify the action's triggering method. The Msmd.h file defines the following bit value constants for this bitmap:

 MDACTION_TYPE_URL (0x01)

 MDACTION_TYPE_HTML (0x02)

 MDACTION_TYPE_STATEMENT (0x04)

 MDACTION_TYPE_DATASET (0x08)

 MDACTION_TYPE_ROWSET (0x10)

 MDACTION_TYPE_COMMANDLINE (0x20)

 MDACTION_TYPE_PROPRIETARY (0x40)

 MDACTION_TYPE_REPORT (0x80)

 MDACTION_TYPE_DRILLTHROUGH (0x100)
COORDINATEDBTYPE_WSTRA Multidimensional Expressions (MDX) expression that specifies an object or a coordinate in the multidimensional space in which the action is performed. It is the responsibility of the client application to provide the value of this restriction column.

The CORDINATE must resolve to the object specified in COORDINATE_TYPE.
COORDINATE_TYPEDBTYPE_I4A bitmap that specifies how the COORDINATE restriction column is interpreted. The Msmd.h file defines the following bit value constants for this bitmap:

 MDACTION_COORDINATE_CUBE (1)

 MDACTION_COORDINATE_DIMENSION (2): refers to the dimensions hierarchies.

 MDACTION_COORDINATE_LEVEL (3)

 MDACTION_COORDINATE_MEMBER (4)

 MDACTION_COORDINATE_SET (5)

 MDACTION_COORDINATE_CELL (6)
ACTION_CAPTIONDBTYPE_WSTRThe action name if no caption was specified and no translations were specified in the DDL.

If a caption or translations were specified, and CaptionIsMDX is false, one of the following strings:

-The translation for the appropriate language.

-The specified caption if no translation was found for the specified language.

-The action name if no translation was found and the caption was not specified in DDL.

If a caption or translations were specified, and CaptionIsMDX is true, the string resulting from finding the appropriate translation for the specified language or the specified translation in the DDL caption, and calculating the formula to create the string.

If the action was specified in MDX Script, there are no translations and the caption is always treated as MDX expression.
DESCRIPTIONDBTYPE_WSTRA user-friendly description of the action.
CONTENTDBTYPE_WSTRThe expression or content of the action that is to be run.
APPLICATIONDBTYPE_WSTRThe name of the application that is to be used to run the action.
INVOCATIONDBTYPE_I4Information about how the action should be invoked:

 MDACTION_INVOCATION_INTERACTIVE (1) indicates a regular action used during normal operations. This is the default value for this column.

 MDACTION_INVOCATION_ON_OPEN (2) indicates that the action should be performed when the cube is first opened.

 MDACTION_INVOCATION_BATCH (4) indicates that the action is performed as part of a batch operation or Microsoft SQL Server Integration Services task.

 

Note that these enumeration values are defined in the file, Msmd.h.

The rowset is sorted on CATALOG_NAME, SCHEMA_NAME, CUBE_NAME, ACTION_NAME.

System_CAPS_ICON_note.jpg Note


Actions of MDACTION_TYPE_PROPRIETARY type must provide a value for the APPLICATION column.

The MDSCHEMA_ACTIONS rowset can be restricted on the columns listed in the following table.

Column nameType indicatorRestriction State
CATALOG_NAMEDBTYPE_WSTROptional
SCHEMA_NAMEDBTYPE_WSTROptional
CUBE_NAMEDBTYPE_WSTRMandatory
ACTION_NAMEDBTYPE_WSTROptional
ACTION_TYPEDBTYPE_I4Optional
COORDINATEDBTYPE_WSTRMandatory
COORDINATE_TYPEDBTYPE_I4Mandatory
INVOCATIONDBTYPE_I4(Optional) The INVOCATION restriction column defaults to the value of MDACTION_INVOCATION_INTERACTIVE. To retrieve all actions, use the MDACTION_INVOCATION_ALL value in the INVOCATION restriction column.
CUBE_SOURCEDBTYPE_UI2(Optional) Default restriction is a value of 1. A bitmap with one of the following valid values:

1 CUBE

2 DIMENSION
System_CAPS_ICON_important.jpg Important


The INVOCATION restriction column has a default value of MDACTION_INVOCATION_INTERACTIVE. Any schema rowset that does not explicitly specify a value for this column contains only rows with this value. If you want the rowset to contain the entire set of actions, use the MDACTION_INVOCATION_ALL constant in the INVOCATION restriction column.

Client applications can define more than one ACTION_TYPE by using the OR operator.

The following table lists the valid COORDINATE and COORDINATE_TYPE combinations.

COORDINATE object typeCOORDINATE_TYPE
CubeMDACTION_COORDINATE_CUBE
DimensionMDACTION_COORDINATE_DIMENSION

 MDACTION_COORDINATE_LEVEL

 MDACTION_COORDINATE_MEMBER

 MDACTION_COORDINATE_SET

 MDACTION_COORDINATE_CELL
HierarchyMDACTION_COORDINATE_DIMENSION
LevelMDACTION_COORDINATE_LEVEL
MemberMDACTION_COORDINATE_MEMBER
SetMDACTION_COORDINATE_SET
cellMDACTION_COORDINATE_CELL

OLE DB for OLAP Schema Rowsets

Community Additions

ADD
Show: