TechNet
Export (0) Print
Expand All

MDSCHEMA_KPIS Rowset

 

Applies To: SQL Server 2016 Preview

Describes the key performance indicators (KPIs) within a database.

The MDSCHEMA_KPIS rowset contains the following columns.

Column nameType indicatorDescription
CATALOG_NAMEDBTYPE_WSTRThe source database.
SCHEMA_NAMEDBTYPE_WSTRNot supported.
CUBE_NAMEDBTYPE_WSTRThe parent cube for the KPI.
MEASUREGROUP_NAMEDBTYPE_WSTRThe associated measure group for the KPI.

You can use this column to determine the dimensionality of the KPI. If "<NULL>", the KPI will be dimensioned by all measure groups.

The default value is "<NULL>".
KPI_NAMEDBTYPE_WSTRThe name of the KPI.
KPI_CAPTIONDBTYPE_WSTRA label or caption associated with the KPI. Used primarily for display purposes. If a caption does not exist, KPI_NAME is returned.
KPI_DESCRIPTIONDBTYPE_WSTRA human-readable description of the KPI.
KPI_DISPLAY_FOLDERDBTYPE_WSTRA string that identifies the path of the display folder that the client application uses to show the member. The folder level separator is defined by the client application. For the tools and clients supplied by Analysis Services, the backslash (\) is the level separator. To provide multiple display folders, use a semicolon (;) to separate the folders.
KPI_VALUEDBTYPE_WSTRThe unique name of the member in the measures dimension for the KPI Value.
KPI_GOALDBTYPE_WSTRThe unique name of the member in the measures dimension for the KPI Goal.

Returns NULL if there is no Goal defined.
KPI_STATUSDBTYPE_WSTRThe unique name of the member in the measures dimension for the KPI Status.

Returns NULL if there is no Status defined.
KPI_TRENDDBTYPE_WSTRThe unique name of the member in the measures dimension for the KPI Trend.

Returns NULL if there is no Trend defined.
KPI_STATUS_GRAPHICDBTYPE_WSTRThe default graphical representation of the KPI.
KPI_TREND_GRAPHICDBTYPE_WSTRThe default graphical representation of the KPI.
KPI_WEIGHTDBTYPE_WSTRThe unique name of the member in the measures dimension for the KPI Weight.
KPI_CURRENT_TIME_MEMBERDBTYPE_WSTRThe unique name of the member in the time dimension that defines the temporal context of the KPI.

Returns NULL if there is no Time member defined.
KPI_PARENT_KPI_NAMEDBTYPE_WSTRThe name of the parent KPI.
SCOPEDBTYPE_I4The scope of the KPI. The KPI can be a session KPI or global KPI.

This column can have one of the following values:

MDKPI_SCOPE_GLOBAL=1

MDKPI_SCOPE_SESSION=2
ANNOTATIONSDBTYPE_WSTR(Optional) A set of notes, in XML format.

This schema rowset is not sorted.

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

Column nameType indicatorRestriction State
CATALOG_NAMEDBTYPE_WSTROptional.
SCHEMA_NAMEDBTYPE_WSTROptional.
CUBE_NAMEDBTYPE_WSTROptional.
KPI_NAMEDBTYPE_WSTROptional.
CUBE_SOURCEDBTYPE_UI2(Optional) Default restriction is a value of 1. A bitmap with one of the following valid values:

 1 CUBE

 2 DIMENSION

OLE DB for OLAP Schema Rowsets

Community Additions

ADD
Show:
© 2016 Microsoft