Export (0) Print
Expand All

Supported XMLA Properties (XMLA)

Microsoft SQL Server Analysis Services supports the properties listed in the following table. You use these listed properties in the Properties element of the Discover and Execute methods.

Name

Element

AxisFormat

Usage

Optional, write-only String property

Description

Determines the format used within an MDDataSet result set to describe the axes of the multidimensional dataset. This property can have the values listed in the following table.

Value

Description

ClusterFormat

The MDDataSet axis is made up of one or more CrossProduct elements.

CustomFormat

Analysis Services uses the TupleFormat format for this setting.

TupleFormat

(Default) The MDDataSet axis contains one or more Tuple elements.

This property can be used with the Execute method.

BeginRange

Usage

Optional, write-only Integer property

Description

Contains a zero-based integer value corresponding to a CellOrdinal attribute value. (The CellOrdinal attribute is part of the Cell element in the CellData section of MDDataSet.)

Used together with the EndRange property, the client application can use this property to restrict an OLAP dataset returned by a command to a specific range of cells. If -1 is specified, all cells up to the cell specified in the EndRange property are returned.

The default value for this property is -1.

This property can be used with the Execute method.

Catalog

Usage

Optional, read/write String property

Description

When establishing a session with an Analysis Services instance to send an XMLA command, this property is equivalent to the OLE DB property, DBPROP_INIT_CATALOG.

When you set this property during a session to change the current database for the session, this property is equivalent to the OLE DB property, DBPROP_CURRENTCATALOG.

The default value for this property is an empty string.

This property can be used with the Discover and Execute methods.

CatalogLocation

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_CATALOGLOCATION.

The default value for this property is zero (0), equivalent to DBPROPVAL_CL_START.

This property can be used with the Discover and Execute methods.

ClientProcessID

Usage

Optional, read/write Integer property

Description

Contains the identifier (ID) of the process thread for the current session.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

CommitTimeout

Usage

Optional, write-only Integer property

Description

Determines how long, in seconds, the commit phase of a currently running XMLA command waits before rolling back. The commit phase corresponds to XMLA commands such as Statement or Process.

A value of zero (0) indicates that the instance waits indefinitely.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

Content

Usage

Optional, write-only String property

Description

Determines the type of data that is returned from the Discover and Execute methods. This property can have the values listed in the following table.

Value

Description

None

Allows the structure of the command to be verified, but not run.

Schema

Returns the XML schema that relates to the requested command. The XML schema indicates columns and other information.

Data

Returns only the data that was requested.

SchemaData

(Default) Returns the schema information and the data.

This property can be used with the Discover and Execute methods.

Cube

Usage

Optional, write-only String property

Description

Contains the name of the cube that sets the context for the command. If the command itself contains a cube name, such as within the FROM clause of a Multidimensional Expressions (MDX) SELECT statement, the setting of this property is ignored.

The default value for this property is an empty string.

This property can be used with the Discover and Execute methods.

DataSourceInfo

Usage

Required, read/write String property

Description

Contains the information, such as the instance name, required to connect to the data source.

Client applications should not construct the contents of the DataSourceInfo property to send to an instance. Instead, the client application should find the data sources supported by the provider by using the Discover method to retrieve the DISCOVER_DATASOURCES rowset. The client application then sends back the same value for the DataSourceInfo property that the client retrieved from the DISCOVER_DATASOURCES rowset.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropCatalogTerm

Usage

Optional, read-only String property

Description

This property is equivalent to the OLE DB property, DBPROP_CATALOGTERM.

The default value for this property is "Database".

This property can be used with the Discover and Execute methods.

DbpropCatalogUsage

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_CATALOGUSAGE.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropColumnDefinition

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_COLUMNDEFINITION.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropConcatNullBehavior

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_CONCATNULLBEHAVIOR.

The default value for this property is 1, equivalent to DBPROPVAL_CB_NULL.

This property can be used with the Discover and Execute methods.

DbpropDataSourceReadOnly

Usage

Optional, read-only Boolean property

Description

This property is equivalent to the OLE DB property, DBPROP_DATASOURCEREADONLY.

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

DbpropGroupBy

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_GROUPBY.

The default value for this property is 2, equivalent to DBPROPVAL_GB_EQUALS_SELECT.

This property can be used with the Discover and Execute methods.

DbpropHeterogeneousTables

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_HETEROGENEOUSTABLES.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropIdentifierCase

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_IDENTIFIERCASE.

The default value for this property is 8, equivalent to DBPROPVAL_IC_MIXED.

This property can be used with the Discover and Execute methods.

DbpropInitMode

Usage

Optional, read/write Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_INIT_MODE.

The only supported values for this property are DB_MODE_READWRITE and DB_MODE_READ.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMaxIndexSize

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_MAXINDEXSIZE.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropMaxOpenChapters

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_MAXOPENCHAPTERS.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropMaxRowSize

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_MAXROWSIZE.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropMaxRowSizeIncludeBlob

Usage

Optional read-only Boolean property

Description

This property is equivalent to the OLE DB property, DBPROP_MAXROWSIZEINCLUDESBLOB.

The default value for this property is TRUE.

This property can be used with the Discover and Execute methods.

DbpropMaxTablesInSelect

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property DBPROP_MAXTABLESINSELECT.

The default value for this property is 1.

This property can be used with the Discover and Execute methods.

DbpropMsmdAutoexists

Usage

Optional, read/write Integer property

Description

Determines the behavior of autoexists. This property can have the values listed in the following table.

Value

Description

0

Default value, same as 1.

1

Apply deep autoexists for query axes and named sets. Includes WHERE clauses and subselects.

2

Apply deep autoexists for query axes and exclude named sets from autoexists. Includes WHERE clauses and subselects.

3

Apply no autoexists for named sets with WHERE clause. Apply shallow autoexists for query axes with WHERE clause. Apply deep autoexists for query axes with subselects and named sets with subselects.

Zero or empty are the default values for this property.

This is a session property that can only be set when the session is created.

DbpropMsmdCacheMode

Usage

Optional, read/write Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdCachePolicy

Usage

Optional, read/write Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdCacheRatio

Usage

Optional, read/write Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdCacheRatio2

Usage

Optional, read/write Double property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdCompareCaseNotSensitiveStringFlags

Usage

Optional read/write Integer property

Description

Determines case-sensitive string comparison and sort order functionality. This property controls how comparisons are made in character sets that do not support uppercase and lowercase characters, such as katakana for Japanese and Hindi. The value of this property is set in the first connection of the process thread, and affects all subsequent connections in that process thread.

Use the following table to determine which flags to use.

Name

Value

Description

NORM_IGNORECASE

0x00000001

Case is ignored.

Not applicable

0x00000002

Binary comparison. Characters are compared based on their underlying value in the character set, not on their order in their particular alphabet.

NORM_IGNORENONSPACE

0x00000010

Nonspacing characters are ignored.

NORM_IGNORESYMBOLS

0x00000100

Symbols are ignored.

NORM_IGNOREKANATYPE

0x00001000

No differentiation is made between hiragana and katakana characters. When compared, corresponding hiragana and katakana characters are considered to be equal.

NORM_IGNOREWIDTH

0x00010000

No differentiation is made between single-byte and double-byte versions of the same character.

SORT_STRINGSORT

0x00100000

Punctuation is treated the same as symbols.

For more information about comparing strings in OLE DB, search on "CompareString" in the Platform SDK section of the MSDN Library.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdCompareCaseSensitiveStringFlags

Usage

Optional, read/write Integer property

Description

Determines case-insensitive string comparison and sort order functionality. This property controls how comparisons are made in character sets that do not support uppercase and lowercase characters, such as katakana for Japanese and Hindi. The value of this property is set in the first connection of the process thread, and affects all subsequent connections in that process thread.

Use the following table to determine which flags to use.

Name

Value

Description

NORM_IGNORECASE

0x00000001

Case is ignored.

Not applicable

0x00000002

Binary comparison. Characters are compared based on their underlying value in the character set, not on their order in their particular alphabet.

NORM_IGNORENONSPACE

0x00000010

Nonspacing characters are ignored.

NORM_IGNORESYMBOLS

0x00000100

Symbols are ignored.

NORM_IGNOREKANATYPE

0x00001000

No differentiation is made between hiragana and katakana characters. When compared, corresponding hiragana and katakana characters are considered to be equal.

NORM_IGNOREWIDTH

0x00010000

No differentiation is made between single-byte and double-byte versions of the same character.

SORT_STRINGSORT

0x00100000

Punctuation is treated the same as symbols.

For more information about comparing strings in OLE DB, search on "CompareString" in the Platform SDK section of the MSDN Library.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdDebugMode

Usage

Optional, read/write String property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdDynamicDebugLimit

Usage

Optional, read/write Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMsmdFlattened2

Usage

Optional, read/write Boolean property

Description

Outputs all members of a parent-child hierarchy in a single table column in the flattened result, unless the parent-child hierarchy is requested on Axis 0. The Level template for output columns is not used.

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

DbpropMsmdMDXCompatibility

Usage

Optional, read/write Integer property

Description

Determines how placeholder members in a ragged or unbalanced hierarchy are treated. This property can have the values listed in the following table.

Value

Description

0

For compatibility with earlier versions of Analysis Services, this value is equivalent to 1

1

Hierarchies in role-playing dimensions receive a caption that includes the dimension name and the hierarchy name. The caption has the following format:

[Dimension].[Hierarchy]

Placeholder members are exposed.

2

Hierarchies in role-playing dimensions receive a caption that includes the dimension name and the hierarchy name The caption has the following format:

[Dimension].[Hierarchy]

Placeholder members are not exposed.

3

(Default) Placeholder members are not exposed.

This property can be used with the Discover and Execute methods.

DbpropMsmdMDXUniqueNameStyle

Usage

Optional, read/write Integer property

Description

Determines the algorithm for generating the unique names of members in a dimension. This property can have the values listed in the following table.

Value

Description

0

For compatibility with earlier versions of Analysis Services, this value is equivalent to 2.

1

Uses a key path algorithm:

[dim].&[key1].&[key2]

2

Uses a name path algorithm:

[dim].[name1].&[name2]

3

Uses guaranteed unique names that are stable over time.

The default value for this property is 6.

This property can be used with the Discover and Execute methods.

DbpropMsmdSQLCompatibility

Usage

Optional, read/write Integer property

Description

Reserved for future use.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropMsmdSubQueries

Usage

Optional, read/write Integer property

Description

A bitmask that determines the behavior of subqueries. This property can have the values listed in the following table.

Value

Description

0

Default value, Compatible with earlier versions of Analysis Services.

Calculated members or calculated sets are not allowed in subselects or subcubes.

1

Calculated members or calculated sets are allowed in subselects or subcubes. Ascendants of the calculated member are not included in the space of the subselect or subcube.

2

Calculated members or calculated sets are allowed in subselects or subcubes. Ascendants of the calculated member are included in the space of the subselect or subcube.

Zero or empty are the default values for this property.

This is a session property that can only be set when the session is created.

See Calculated Members in Subselects and Subcubes for a detailed explanation of the behavior of calculated members or calculated sets in subselects and subcubes.

DbpropMsmdUseFormulaCache

Usage

Optional, read/write String property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

DbpropMultiTableUpdate

Usage

Optional, read-only Boolean property

Description

This property is equivalent to the OLE DB property, DBPROP_MULTITABLEUPDATE.

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

DbpropNullCollation

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_NULLCOLLATION.

The default value for this property is 4, equivalent to DBPROPVAL_NC_LOW.

This property can be used with the Discover and Execute methods.

DbpropOrderByColumnsInSelect

Usage

Optional, read-only Boolean property

Description

This property is equivalent to the OLE DB property, DBPROP_ORDERBYCOLUMNSINSELECT.

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

DbpropOutputParameterAvailable

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_OUTPUTPARAMETERAVAILABILITY.

The default value for this property is 1, equivalent to DBPROPVAL_OA_NOTSUPPORTED.

This property can be used with the Discover and Execute methods.

DbpropPersistentIdType

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_PERSISTENTIDTYPE.

The default value for this property is 4, equivalent to DBPROPVAL_PT_NAME.

This property can be used with the Discover and Execute methods.

DbpropPrepareAbortBehavior

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_PREPAREABORTBEHAVIOR.

The default value for this property is 1, equivalent to DBPROPVAL_CB_DELETE.

This property can be used with the Discover and Execute methods.

DbpropPrepareCommitBehavior

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property DBPROP_PREPARECOMMITBEHAVIOR.

The default value for this property is 1, equivalent to DBPROPVAL_CB_DELETE.

This property can be used with the Discover and Execute methods.

DbpropProcedureTerm

Usage

Optional, read-only String property

Description

This property is equivalent to the OLE DB property, DBPROP_PROCEDURETERM.

The default value for this property is "Calculated member".

This property can be used with the Discover and Execute methods.

DbpropQuotedIdentifierCase

Usage

Optional read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_QUOTEDIDENTIFIERCASE.

The default value for this property is 8, equivalent to DBPROPVAL_IC_MIXED.

This property can be used with the Discover and Execute methods.

DbpropSchemaUsage

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_SCHEMAUSAGE.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropSqlSupport

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_SQLSUPPORT.

The default value for this property is 512, equivalent to DBPROPVAL_SQL_SUBMINIMUM.

This property can be used with the Discover and Execute methods.

DbpropSubqueries

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_SUBQUERIES.

Note Note

While Data Mining Extensions (DMX) supports subqueries, this property refers to subquery support in SQL.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

DbpropSupportedTxnDdl

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_SUPPORTEDTXNDDL.

The default value for this property is zero (0), equivalent to DBPROPVAL_TC_NONE.

This property can be used with the Discover and Execute methods.

DbpropSupportedTxnIsoLevels

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_SUPPORTEDTXNISOLEVELS.

The default value for this property is 4096, equivalent to DBPROPVAL_TI_READCOMMITTED.

This property can be used with the Discover and Execute methods.

DbpropSupportedTxnIsoRetain

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_SUPPORTEDTXNISORETAIN.

The default value for this property is 292, equivalent to a combination of DBPROPVAL_TR_ABORT_NO, DBPROPVAL_TR_COMMIT_NO, and DBPROPVAL_TR_NONE.

This property can be used with the Discover and Execute methods.

DbpropTableTerm

Usage

Optional, read-only String property

Description

This property is equivalent to the OLE DB property, DBPROP_TABLETERM.

The default value for this property is "Cube".

This property can be used with the Discover and Execute methods.

Dialect

Usage

Optional, read/write String property

Description

Establishes the dialect used in the following situations:

  • The dialect that the provider will use the first time that the provider tries to run a query.

  • The dialect used for the execution errors returned as the result of query failures.

The dialects available to this property are listed in the following table.

Name

Value

Description

DBGUID_SQL

C8B522D7-5CF3-11CE-ADE5-00AA0044773D

The SQL parser has precedence.

MDGUID_DM

62C58FED-CCA5-44F1-83B6-7B45682B3904

The DMX parser has precedence.

MDGUID_MDX

A07CCCD0-8148-11D0-87BB-00C04FC33942

The MDX parser has precedence.

You can use the Dialect property when you expect that most of queries will use one particular dialect over any other.

Query syntax can be similar for language dialects, such as DMX and SQL. Because the syntax can be similar, Analysis Services may not be able to infer the dialect from the query syntax. If a query does not run in one dialect, the Analysis Services instance may try to run the query again in a different dialect.

If the Dialect property is set, Analysis Services returns query execution errors in the dialect that has precedence, even if the provider tries to run the query again in another dialect. For example, the Dialect property is set to MDGUID_DM. The provider first tries to run the query as a data mining query, but this query fails. The provider then resubmits the query as an SQL query. However, this SQL query also fails. Because the value of the Dialect property is MDGUID_DM, Analysis Services returns a data mining error message, not an SQL error message.

If the Dialect property is not set, Analysis Services returns query execution errors in the dialect last used. For example, the Dialect property is not set, and a data mining query fails. The provider then resubmits the query as SQL. The SQL query also fails. Because the Dialect property is not set, the provider returns an SQL error message instead of a data mining error message.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

Disable Prefetch Facts

Usage

Optional, read/write Boolean property,

Description

When set to True, the engine stops trying to pre-fetch values for the length of the session.

The default value for this property is False.

EffectiveRoles

Usage

Optional, write-only String property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

EffectiveUserName

Usage

Optional, write-only String property

Description

Specifies the name of an account to use to override the user name when connecting to an Analysis Services instance. The value of the property is not normalized, in that the MDX UserName function returns the literal value if this property is used. This property can only be used by server administrators.

This property supports the following SID types: User, Group, Alias, WellKnownGroup, Computer.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

EndRange

Usage

Optional, write-only Integer property

Description

Specifies a zero-based integer value corresponding to a CellOrdinal attribute value. (The CellOrdinal attribute is part of the Cell element in the CellData section of MDDataSet).

Used together with the BeginRange property, the client application can use this property to restrict an OLAP dataset returned by a command to a specific range of cells. If -1 is specified, all cells from the cell specified in the BeginRange property are returned.

The default value for this property is -1.

This property can be used with the Execute method.

ExecutionMode

Usage

Optional, write-only String property

Description

Reserved for future use.

The default value for this property is Execute.

This property can be used with the Discover and Execute methods.

ForceCommitTimeout

Usage

Optional, write-only Integer property

Description

Determines for how long, in seconds, the commit phase of a currently running XMLA command waits before forcing previously issued commands to roll back. The commit phase corresponds to XMLA commands such as Statement or Process.

A value of zero (0) indicates that the instance waits indefinitely.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

Format

Usage

Optional, write-only String property

Description

Determines the type of result set that is returned from the Discover and Execute methods. This property can have the values listed in the following table.

Value

Description

Tabular

Returns a result set using the Rowset data type.

Multidimensional

Returns a rowset using the MDDataSet data type.

Native

No format is explicitly specified. Analysis Services returns the appropriate format for the command. The actual result type is identified by the namespace of the result.

The default value for this property is Native.

This property can be used with the Discover and Execute methods.

ImpactAnalysis

Usage

Optional, write-only Boolean property

Description

Reserved for future use.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

LocaleIdentifier

Usage

Optional, read/write Integer property

Description

Reads or sets the locale identifier (LCID) used by the Discover or Execute method. For the complete hexadecimal list of language identifiers, look for "Language Identifiers" in the MSDN Library.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

MaximumRows

Usage

Optional, write-only Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

MdpropAggregateCellUpdate

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_AGGREGATECELL_UPDATE.

The default value for this property is 4, equivalent to MDPROPVAL_AU_SUPPORTED.

This property can be used with the Discover and Execute methods.

MdpropAxes

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_AXES.

The default value for this property is 2147483647.

This property can be used with the Discover and Execute methods.

MdpropDrillFunctions

Usage

Optional, read-only Integer property

Description

Determines the level of support for drill functions on the server. The following values are used to build a valid bitmask:

MDPROPVAL_MDF_BASIC (0x01)

MDPROPVAL_MDF_ASYMMETRIC (0x02)

MDPROPVAL_MDF_CALC_MEMBERS (0x04)

The default values are:

3 for SQL Server 2008

7 for SQL Server 2008 R2 and SQL Server 2012

This property can be used with the Discover and Execute methods.

MdpropFlatteningSupport

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_FLATTENING_SUPPORT.

The default value for this property is 1, equivalent to MDPROPVAL_FS_FULL_SUPPORT.

This property can be used with the Discover and Execute methods.

MdpropMdxCaseSupport

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_CASESUPPORT.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

MdpropMdxDescFlags

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_DESCFLAGS.

The default value for this property is 7, equivalent to MDPROPVAL_MD_BEFORE, MDPROPVAL_MD_AFTER, and MDPROPVAL_MD_SELF.

This property can be used with the Discover and Execute methods.

MdpropMdxFormulas

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property MDPROP_MDX_FORMULAS.

The default value for this property is 63, equivalent to a combination of MDPROPVAL_MF_WITH_CALCMEMBERS, MDPROPVAL_MF_WITH_NAMEDSETS, MDPROPVAL_MF_CREATE_CALCMEMBERS, MDPROPVAL_MF_CREATE_NAMEDSETS, MDPROPVAL_MF_SCOPE_SESSION, and MDPROPVAL_MF_SCOPE_GLOBAL.

This property can be used with the Discover and Execute methods.

MdpropMdxJoinCubes

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_JOINCUBES.

The default value for this property is 1, equivalent to MDPROPVAL_MJC_SINGLECUBE.

This property can be used with the Discover and Execute methods.

MdpropMdxMemberFunctions

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_MEMBER_FUNCTIONS.

The default value for this property is 15, equivalent to a combination of all available OLE DB values.

This property can be used with the Discover and Execute methods.

MdpropMdxNamedSets

Usage

Optional, read-only Integer property

Description

A bitmask from values listed in the following table.

Value

Description

0x01

MDPROPVAL_MNS_BASIC.

0x02

MDPROPVAL_MNS_DYNAMIC.

0x04

MDPROPVAL_MNS_DISPLAYFOLDER.

0x08

MDPROPVAL_MNS_CAPTION.

A value of 15 is the default value for this property.

MdpropMdxNonMeasureExpressions

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_NONMEASURE_EXPRESSIONS.

The default value for this property is zero (0), equivalent to MDPROPVAL_NME_ALLDIMENSIONS.

This property can be used with the Discover and Execute methods.

MdpropMdxNumericFunctions

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_NUMERIC_FUNCTIONS.

The default value for this property is 2047, equivalent to a combination of MDPROPVAL_MNF_MEDIAN, MDPROPVAL_MNF_VAR, MDPROPVAL_MNF_STDDEV, MDPROPVAL_MNF_RANK, MDPROPVAL_MNF_AGGREGATE, MDPROPVAL_MNF_COVARIANCE, MDPROPVAL_MNF_CORRELATION, MDPROPVAL_MNF_LINREGSLOPE, MDPROPVAL_MNF_LINREGVARIANCE, MDPROPVAL_MNF_LINREG2, and MDPROPVAL_MNF_LINREGPOINT.

This property can be used with the Discover and Execute methods.

MdpropMdxObjQualification

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_OBJQUALIFICATION.

The default value for this property is 496, equivalent to a combination of MDPROPVAL_MOQ_DIM_HIER, MDPROPVAL_MOQ_DIMHIER_LEVEL, MDPROPVAL_MOQ_DIMHIER_MEMBER, MDPROPVAL_MOQ_LEVEL_MEMBER, and MDPROPVAL_MOQ_MEMBER_MEMBER.

This property can be used with the Discover and Execute methods.

MdpropMdxOuterReference

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property MDPROP_MDX_OUTERREFERENCE.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

MdpropMdxQueryByProperty

Usage

Optional, read-only Boolean property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_QUERYBYPROPERTY.

The default value for this property is TRUE.

This property can be used with the Discover and Execute methods.

MdpropMdxRangeRowset

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_RANGEROWSET.

The default value for this property is 4, equivalent to MDPROPVAL_RR_UPDATE.

This property can be used with the Discover and Execute methods.

MdpropMdxSetFunctions

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_SET_FUNCTIONS.

The default value for this property is 524287, equivalent to a combination of MDPROPVAL_MSF_TOPPERCENT, MDPROPVAL_MSF_BOTTOMPERCENT, MDPROPVAL_MSF_TOPSUM, MDPROPVAL_MSF_BOTTOMSUM, MDPROPVAL_MSF_PERIODSTODATE, MDPROPVAL_MSF_LASTPERIODS, MDPROPVAL_MSF_YTD, MDPROPVAL_MSF_QTD, MDPROPVAL_MSF_MTD, MDPROPVAL_MSF_WTD, MDPROPVAL_MSF_DRILLDOWNMEMBER, MDPROPVAL_MSF_DRILLDOWNLEVEL, MDPROPVAL_MSF_DRILLDOWNMEMBERTOP, MDPROPVAL_MSF_DRILLDOWNMEMBERBOTTOM, MDPROPVAL_MSF_DRILLDOWNLEVEL, MDPROPVAL_MSF_DRILLDOWNLEVELTOP, MDPROPVAL_MSF_DRILLDOWNLEVELBOTTOM, MDPROPVAL_MSF_DRILLUPMEMBER, MDPROPVAL_MSF_DRILLUPLEVEL, and MDPROPVAL_MSF_TOGGLEDRILLSTATE.

This property can be used with the Discover and Execute methods.

MdpropMdxSlicer

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_SLICER.

The default value for this property is 2, equivalent to MDPROPVAL_MS_SINGLETUPLE.

This property can be used with the Discover and Execute methods.

MdpropMdxStringCompop

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_MDX_STRING_COMPOP.

The default value for this property is 15, equivalent to a combination of MDPROPVAL_MSC_LESSTHAN, MDPROPVAL_MSC_GREATERTHAN, MDPROPVAL_MSC_LESSTHANEQUAL, and MDPROPVAL_MSC_GREATERTHANEQUAL.

This property can be used with the Discover and Execute methods.

MdpropMdxSubQueries

Usage

Optional, read-only Integer property

Description

Indicates the level of support for subqueries in MDX. A bitmask from values listed in the following table.

Value

Description

0x01

MDPROPVAL_MSQ_BASIC.

0x02

MDPROPVAL_MSQ_ARBITRARYSHAPE.

0x04

MDPROPVAL_MSQ_NONVISUAL.

0x08

MDPROPVAL_MSQ_CALCMEMBERS.

0x10

MDPROPVAL_MSQ_CALCMEMBERS2

A value of 63 is the default value for this property in SQL Server 2014.

A value of 31 is the default value for this property in SQL Server 2008 R2 and SQL Server 2012

A value of 15 is the default value for this property in SQL Server 2008

A value of 3 is the default value for this property in SQL Server 2005 Analysis Services.

MdpropNamedLevels

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_NAMED_LEVELS.

The default value for this property is 3, equivalent to a combination of MDPROPVAL_NL_NAMEDLEVELS and MDPROPVAL_NL_NUMBEREDLEVELS.

This property can be used with the Discover and Execute methods.

MdxMissingMemberMode

Usage

Optional, write-only String property

Description

Indicates whether missing members are ignored in MDX statements.

This property can have the values listed in the following table.

Value

Description

Default

Use value generated by the Analysis Services instance.

Error

Generate an error.

Ignore

Always ignore missing members.

This property is equivalent to the OLE DB property, DBPROP_MDX_MISSING_MEMBER_MODE.

The default value for this property is Default.

This property can be used with the Discover and Execute methods.

MDXSupport

Usage

Optional, read-only String property

Description

Specifies an enumeration that describes the degree of MDX support.

This property can have the values listed in the following table.

Value

Description

Core

All MDX options are supported.

Note Note

Currently, the only value that the enumeration contains is Core. In future releases, other values will be defined for this enumeration.

The default value for this property is Core.

This property can be used with the Discover method.

NonEmptyThreshold

Usage

Optional read/write Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

Password

Usage

Optional write-only String property

Note Note

This property is no longer supported.

Description

For backward compatibility, this property is ignored without generating an error when used with the Execute or Discover method.

ProviderName

Usage

Optional, read-only String property

Description

This property is equivalent to the OLE DB property, DBPROP_DBMSNAME.

The default value for this property is "OLAP Server".

This property can be used with the Discover method.

ProviderType

Usage

Optional, read-only Integer property

Description

This property is equivalent to the OLE DB property, DBPROP_DATASOURCE_TYPE.

The default value for this property is 6.

This property can be used with the Discover and Execute methods.

ProviderVersion

Usage

Optional, read-only String property

Description

This property is equivalent to the OLE DB property, DBPROP_DBMSVER.

The default value for this property is the version of the Analysis Services instance.

This property can be used with the Discover method.

ReadOnlySession

Usage

Optional, read/write Integer property

Description

Reserved for future use.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

RealTimeOlap

Usage

Optional, read/write Boolean property

Description

When set to TRUE, indicates that all the partitions listening for table notifications are to be queried in real time, bypassing caching. This property is equivalent to the OLE DB property, DBPROP_MSMD_REAL_TIME_OLAP.

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

ReturnCellProperties

Usage

Optional, read/write Boolean property

Description

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

Roles

Usage

Optional, read/write String property

Description

Specifies a comma-delimited string of the role names under which a client application connects to an Analysis Services instance. This property lets the user connect using a role other than the one he or she is currently using. For example, a server administrator may want to connect to a cube as a member of a role to test permissions granted to that role. This user must be a member of the role specified in order to connect using this property.

Important note Important

Role names are case-sensitive, and spaces should not be used between the comma-delimited role names. Otherwise errors and unexpected results may be returned by queries to secured cell sets.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

SafetyOptions

Usage

Optional, read/write Integer property

Description

Determines whether unsafe libraries can be registered and loaded by client applications.

The value of this property also determines whether the PASSTHROUGH keyword is allowed in local cubes. An error occurs in the following situations:

  • If a client application tries to create a local cube with an INSERT INTO statement that contains the PASSTHROUGH keyword.

  • If a client application tries to update a local cube that contains an INSERT INTO statement which uses the PASSTHROUGH keyword.

This property can have the values listed in the following table.

Name

Value

Description

DBPROPVAL_MSMD_SAFETY_OPTIONS_DEFAULT

0

This value is treated as DBPROPVAL_MSMD_SAFETY_OPTIONS_ALLOW_SAFE.

For connections to a local cube, this value depends on whether the CREATECUBE connection string property is used. If the CREATECUBE connection string property is used, this value is the same as DBPROPVAL_MSMD_SAFETY_OPTIONS_ALLOW_ALL. Otherwise, this value is the same as DBPROPVAL_MSMD_SAFETY_OPTIONS_ALLOW_SAFE.

DBPROPVAL_MSMD_SAFETY_OPTIONS_ALLOW_ALL

1

This value enables all user-defined function libraries without verifying that they are safe for initialization and scripting. For connections to local cubes, this value enables usage of stored procedures and of the PASSTHROUGH keyword in INSERT INTO statements.

Security note Security Note

We do not recommend this option.

DBPROPVAL_MSMD_SAFETY_OPTIONS_ALLOW_SAFE

2

This value makes sure that all classes for a particular user-defined function library are checked to make sure that they are safe for initialization and scripting. For connections to local cubes, this value prevents usage of the PASSTHROUGH keyword in INSERT INTO statements and of stored procedures where the PermissionSet property is not set to Safe.

This value also removes actions in the MDSCHEMA_ACTIONS schema rowset that have either a value of HTML or COMMAND in the ACTION_TYPE column, or have a value of URL in the ACTION_TYPE column and a value in the CONTENT column that does not start with "http://" or "https://".

DBPROPVAL_MSMD_SAFETY_OPTIONS_ALLOW_NONE

3

This value prevents user-defined functions from being used during the session. For connections to local cubes, this value prevents usage of all stored procedures and of the PASSTHROUGH keyword in INSERT INTO statements.

This value also removes all actions in the MDSCHEMA_ACTIONS schema rowset.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

SecuredCellValue

Usage

Optional, read/write Integer property

Description

Specifies the error code and the values for the Value and Formatted Value cell properties to be returned when it tries to access a secured cell.

This property can have the values listed in the following table.

Value

Description

0

(Default) For compatibility with earlier versions, this value is the same as 1. The meaning of this default value is subject to change in future versions.

1

Returns: HRESULT = NO_ERROR

The Value property of the cell contains the result as a variant data type. The string "#N/A" is returned in the Formatted Value property.

2

Returns an error as the value of HRESULT.

3

Returns NULL in both the Value and Formatted Value properties.

4

Returns a numeric zero (0) in the Value property, and returns a formatted zero in the Formatted Value property. For example, 0.00 is returned in the Formatted Value property for a cell whose Format property is "#.##".

5

Returns the string "#SEC" in both the Value and Formatted Value properties.

This property can be used with the Discover and Execute methods.

ServerName

Usage

Optional, read-only String property

Description

This property is equivalent to the OLE DB property, DBPROP_SERVERNAME.

The default value for this property is the name of the Analysis Services instance.

This property can be used with the Discover and Execute methods.

ShowHiddenCubes

Usage

Optional, read/write Boolean property

Description

Reserved for future use.

The default value for this property is FALSE.

This property can be used with the Discover and Execute methods.

SQLQueryMode

Usage

Optional, read/write String property

Description

Determines whether calculations are included in SQL queries.

This property can have the values listed in the following table.

Value

Description

Data

No calculations are included.

Calculated

Calculations are returned.

IncludeEmpty

Calculations and empty rows are returned.

The default value for this property is Calculated.

This property can be used with the Discover and Execute methods.

SQLSupport

Usage

Optional, read-only Integer property

Description

The default value for this property is 512.

This property can be used with the Discover and Execute methods.

SspropInitAppName

Usage

Optional, read/write String property

Description

Contains the name of the client application.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

SspropInitPacketsize

Usage

Optional, read/write Integer property

Description

Contains the ID of the client application.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

SspropInitWsid

Usage

Optional, read/write String property

Description

Contains the ID of the client workstation.

There is no default value for this property.

This property can be used with the Discover and Execute methods.

StateSupport

Usage

Optional, read-only String property

Description

Specifies the degree of support for statefulness.

This property can have the values listed in the following table.

Value

Description

None

Statefulness is not supported.

Sessions

Statefulness is provided through session support.

For more information about statefulness and session support, see Managing Connections and Sessions (XMLA).

The default value for this property is Sessions.

This property can be used with the Discover method.

Timeout

Usage

Optional, read/write Integer property

Description

Specifies, in seconds, the maximum time that the Analysis Services instance should wait for a request to be successful before returning an error. This property also determines the maximum time that the instance should wait for an update to a writeback table to be successful before returning an error, equivalent to the connection string property, Writeback Timeout.

The default value for this property is zero (0).

This property can be used with the Discover and Execute methods.

TransactionDDL

Usage

Optional, read-only Integer property

Description

Reserved for future use.

The default value for this property is 0.

This property can be used with the Discover and Execute methods.

UserName

Usage

Optional, read-only String property

Note Note

This property is no longer supported.

Description

Specifies a string that returns the user name that the Analysis Services instance associates with the command. For backward compatibility, this property is ignored without generating an error when used with the Execute or Discover method. This property is equivalent to the OLE DB property, DBPROP_USERNAME.

The default value for this property is the user name that opened the current session or connection.

This property can be used with the Execute method.

VisualMode

Usage

Optional, write-only Integer property

Description

This property is equivalent to the OLE DB property, MDPROP_VISUALMODE.

The default value for this property is zero (0), equivalent to DBPROPVAL_VISUAL_MODE_DEFAULT.

This property can be used with the Discover and Execute methods.

Community Additions

ADD
Show:
© 2014 Microsoft