3.1.4.2.2.1.2.1 PropertyList
The PropertyList type contains the properties that are associated with a Discover or Execute request. Only writeable properties can be sent to the server in a request. Attempts to send properties that are not writeable or that are reserved for future use will result in a fault.
-
<xsd:complexType name="PropertyList" > <xsd:all> <xsd:element name="DataSourceInfo" type="xsd:string" minOccurs="0" /> <xsd:element name="Timeout" type="xsd:integer" minOccurs="0" /> <xsd:element name="UserName" type="xsd:string" minOccurs="0" /> <xsd:element name="Password" type="xsd:string" minOccurs="0" /> <xsd:element name="LocaleIdentifier" type="xsd:integer" minOccurs="0" /> <xsd:element name="Catalog" type="xsd:string" minOccurs="0" /> <xsd:element name="StateSupport" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="None" /> <xsd:enumeration value="Sessions" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Content" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="None" /> <xsd:enumeration value="Schema" /> <xsd:enumeration value="Data" /> <xsd:enumeration value="SchemaData" /> <xsd:enumeration value="Metadata" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="Format" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="Tabular" /> <xsd:enumeration value="Multidimensional" /> <xsd:enumeration value="Native" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="AxisFormat" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="ClusterFormat" /> <xsd:enumeration value="CustomFormat" /> <xsd:enumeration value="TupleFormat" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="BeginRange" type="xsd:integer" minOccurs="0" /> <xsd:element name="EndRange" type="xsd:integer" minOccurs="0" /> <xsd:element name="MDXSupport" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="Core" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="ProviderName" type="xsd:string" minOccurs="0" /> <xsd:element name="ProviderVersion" type="xsd:string" minOccurs="0" /> <xsd:element name="DBMSVersion" type="xsd:string" minOccurs="0" /> <xsd:element name="ProviderType" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> <xsd:enumeration value="4" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="ShowHiddenCubes" type="xsd:boolean" minOccurs="0" /> <xsd:element name="SQLSupport" type="xsd:integer" minOccurs="0" /> <xsd:element name="TransactionDDL" type="xsd:integer" minOccurs="0" /> <xsd:element name="MaximumRows" type="xsd:integer" minOccurs="0" /> <xsd:element name="Roles" type="xsd:string" minOccurs="0" /> <xsd:element name="VisualMode" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="EffectiveRoles" type="xsd:string" minOccurs="0" /> <xsd:element name="EffectiveUserName" type="xsd:string" minOccurs="0" /> <xsd:element name="ServerName" type="xsd:string" minOccurs="0" /> <xsd:element name="CatalogLocation" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropCatalogTerm" type="xsd:string" minOccurs="0" /> <xsd:element name="DbpropCatalogUsage" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropColumnDefinition" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropConcatNullBehavior" minOccurs="0 " > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropDataSourceReadOnly" type="xsd:boolean" minOccurs="0" /> <xsd:element name="DbpropGroupBy" minOccurs="0" type="xsd:integer" /> <xsd:element name="DbpropHeterogeneousTables" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropIdentifierCase" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMaxIndexSize" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMaxOpenChapters" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMaxRowSize" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMaxRowSizeIncludeBlob" type="xsd:boolean" minOccurs="0" /> <xsd:element name="DbpropMaxTablesInSelect" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMultiTableUpdate" type="xsd:boolean" minOccurs="0" /> <xsd:element name="DbpropNullCollation" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="4" /> <xsd:enumeration value="8" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropOrderByColumnsInSelect" type="xsd:boolean" minOccurs="0" /> <xsd:element name="DbpropOutputParameterAvailable" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="4" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropPersistentIdType" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="4" /> <xsd:enumeration value="8" /> <xsd:enumeration value="16" /> <xsd:enumeration value="32" /> <xsd:enumeration value="64" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropPrepareAbortBehavior" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropPrepareCommitBehavior" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropProcedureTerm" type="xsd:string" minOccurs="0" /> <xsd:element name="DbpropQuotedIdentifierCase" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="4" /> <xsd:enumeration value="8" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropSchemaUsage" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropSqlSupport" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropSubqueries" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropSupportedTxnDdl" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxSubqueries" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropSupportedTxnIsoLevels" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropSupportedTxnIsoRetain" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropTableTerm" type="xsd:string" minOccurs="0" /> <xsd:element name="MdpropAggregateCellUpdate" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MdpropAxes" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropFlatteningSupport" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> <xsd:enumeration value="4" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MdpropMdxCaseSupport" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxDescFlags" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxDrillFunctions" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxFormulas" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxJoinCubes" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxMemberFunctions" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxNonMeasureExpressions" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer"> <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MdpropMdxNumericFunctions" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxObjQualification" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxOuterReference" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxQueryByProperty" type="xsd:boolean" minOccurs="0" /> <xsd:element name="MdpropMdxRangeRowset" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="4" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MdpropMdxSetFunctions" type="xsd:integer" minOccurs="0" /> <xsd:element name="MdpropMdxSlicer" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MdpropMdxStringCompop" type="xsd:integer" minOccurs="0"/> <xsd:element name="MdpropNamedLevels" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMsmdMDXCompatibility" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropMsmdSQLCompatibility" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMsmdMDXUniqueNameStyle" type="xsd:integer" minOccurs="0"/> <xsd:element name="DbpropMsmdCachePolicy" type="xsd:integer" minOccurs="0"/> <xsd:element name="DbpropMsmdCacheRatio" type="xsd:integer" minOccurs="0"/> <xsd:element name="DbpropMsmdCacheMode" type="xsd:integer" minOccurs="0"/> <xsd:element name="DbpropMsmdCompareCaseSensitiveStringFlags" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="16" /> <xsd:enumeration value="256" /> <xsd:enumeration value="4096" /> <xsd:enumeration value="65536" /> <xsd:enumeration value="1048576" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropMsmdCompareCaseNotSensitiveStringFlags" Type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMsmdFlattened2" type="xsd:boolean" minOccurs="0" /> <xsd:element name="DbpropInitMode" type="xsd:integer" minOccurs="0"/> <xsd:element name="SspropInitAppName" type="xsd:string" minOccurs="0"/> <xsd:element name="SspropInitWsid" type="xsd:string" minOccurs="0" /> <xsd:element name="SspropInitPacketsize" type="xsd:integer" minOccurs="0"/> <xsd:element name="ReadOnlySession" type="xsd:integer" minOccurs="0" /> <xsd:element name="SecuredCellValue" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> <xsd:enumeration value="4" /> <xsd:enumeration value="5" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="NonEmptyThreshold" type="xsd:integer" minOccurs="0"/> <xsd:element name="SafetyOptions" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropMsmdCacheRatio2" type="xsd:double" minOccurs="0"/> <xsd:element name="DbpropMsmdUseFormulaCache" type="xsd:string" minOccurs="0"/> <xsd:element name="DbpropMsmdDynamicDebugLimit" type="xsd:integer" minOccurs="0"/> <xsd:element name="DbpropMsmdDebugMode" type="xsd:string" minOccurs="0"/> <xsd:element name="Dialect" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="MDX" /> <xsd:enumeration value="DMX" /> <xsd:enumeration value="SQL" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="ImpactAnalysis" type="xsd:boolean" minOccurs="0" /> <xsd:element name="SQLQueryMode" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="Data" /> <xsd:enumeration value="Calculated" /> <xsd:enumeration value="IncludeEmpty" /> <xsd:enumeration value="DataKeys" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="ClientProcessID" type="xsd:integer" minOccurs="0"/> <xsd:element name="Cube" type="xsd:string" minOccurs="0" /> <xsd:element name="ReturnCellProperties" type="xsd:boolean" minOccurs="0" /> <xsd:element name="CommitTimeout" type="xsd:integer" minOccurs="0"/> <xsd:element name="ForceCommitTimeout" type="xsd:integer" minOccurs="0"/> <xsd:element name="ExecutionMode" type="xsd:string" minOccurs="0"/> <xsd:element name="RealTimeOlap" type="xsd:boolean" minOccurs="0" /> <xsd:element name="MdxMissingMemberMode" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="Default" /> <xsd:enumeration value="Ignore" /> <xsd:enumeration value="Error" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MdpropMdxNamedSets" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMsmdSubqueries" minOccurs="0" > <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropMsmdAutoExists" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> <xsd:enumeration value="3" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="CustomData" type="xsd:string" minOccurs="0"/> <xsd:element name="DisablePrefetchFacts" type="xsd:boolean" minOccurs="0" /> <xsd:element name="UpdateIsolationLevel" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="1" /> <xsd:enumeration value="2" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropMsmdErrorMessageMode" type="xsd:integer" minOccurs="0"/> <xsd:element name="MdpropMdxDdlExtensions" type="xsd:integer" minOccurs="0" /> <xsd:element name="ResponseEncoding" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:string" > <xsd:enumeration value="Default" /> <xsd:enumeration value="UTF-8" /> <xsd:enumeration value="UTF-16" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="MemoryLockingMode" minOccurs="0"> <xsd:simpleType> <xsd:restriction base="xsd:integer" > <xsd:enumeration value="0" /> <xsd:enumeration value="1" /> </xsd:restriction> </xsd:simpleType> </xsd:element> <xsd:element name="DbpropMsmdOptimizeResponse" type="xsd:integer" minOccurs="0"/> <xsd:element name="DbpropMsmdActivityID" type="xsd:string" minOccurs="0"/> <xsd:element name="DbpropMsmdRequestID" type="xsd:string" minOccurs="0"/> <xsd:element name="ReturnAffectedObjects" type="xsd:integer" minOccurs="0" /> <xsd:element name="DbpropMsmdRequestMemoryLimit" type="xsd:integer" minOccurs="0" /> <xsd:element name="ApplicationContext" type="xsd:string" minOccurs="0" /> </xsd:all> </xsd:complexType>
Name |
Usage |
Default value |
Description |
---|---|---|---|
DataSourceInfo |
Read/Write |
Empty |
Contains the information, such as the instance name, that is required to connect to the data source. |
LocaleIdentifier |
Read/Write |
|
An integer that represents an LCID. This property represents the LCID that is currently in effect. |
Timeout |
Read/Write |
0 |
An integer value that specifies, in seconds, the maximum time that the server is to wait for a request to be successful before returning an error. |
UserName |
Read |
|
The user name. |
Catalog |
Read/Write |
|
The current database for the session. |
Password |
Write |
|
The password for the session. |
StateSupport |
Read |
"Sessions" |
Reserved for future use. |
Content |
Write |
"SchemaData" |
An enumeration value that determines the type of data that is returned from the Discover and Execute methods. This property can have one of the following values:
|
Format |
Write |
"Native" |
An enumeration value that determines the type of result set that is returned from the Execute method. This property can have one of the following values:
|
AxisFormat |
Write |
"TupleFormat" |
An enumeration value that determines the format used within an mddataset result set to describe the axes of the multidimensional dataset. This property can have one of the following values:
|
BeginRange |
Write |
-1 |
Contains a zero-based integer value corresponding to a CellOrdinal attribute value, which indicates the beginning of the range of cells to include in the result. The CellOrdinal attribute is part of the Cell element in the CellData section of mddataset. |
EndRange |
Write |
-1 |
Specifies a zero-based integer value corresponding to a CellOrdinal attribute value, indicating the end of the range of cells to include in the result. The CellOrdinal attribute is part of the Cell element in the CellData section of mddataset. |
ProviderName |
Read |
|
This property is equivalent to the DBPROP_PROVIDERFRIENDLYNAME OLE DB property. Indicates the name of the provider. |
ProviderVersion |
Read |
|
This property is equivalent to the DBPROP_PROVIDERVER OLE DB property. Indicates the version of the provider. |
DBMSVersion |
Read |
|
This property is equivalent to the DBPROP_DBMSVER OLE DB property. Indicates the server version number. |
ProviderType |
Read |
6 |
This property is equivalent to the DBPROP_DATASOURCE_TYPE OLE DB property. This property can have one of the following values or a combination of the following values:
|
ShowHiddenCubes |
Read/Write |
|
This property is reserved for future use. |
SQLSupport |
Read |
512 (DBPROPVAL_SQL_SUBMINIMUM) |
This property is equivalent to the DBPROP_SQLSUPPORT OLE DB property which is a bitmask displaying the level of support for the SQL language. This property can have a combination of zero or more of the following values:
|
TransactionDDL |
Read |
|
Reserved for future use. |
MaximumRows |
Write |
|
Reserved for future use. |
Roles |
Read/Write |
|
Specifies a comma-delimited string of the role names for this request. |
VisualMode |
Write |
0 |
This property is equivalent to the MDPROP_VISUALMODE OLE DB property. Indicates whether the provider is to calculate visual totals, which dynamically totals child members of parent members specified in a set. This property can have one of the following values:
|
EffectiveRoles |
Write |
|
Reserved for future use. |
EffectiveUserName |
Write |
|
Specifies the name of an account to use to override the user name when connecting to the server. |
ServerName |
Read |
|
Indicates the name of the server. |
CatalogLocation |
Read |
|
An integer enumeration value that is equivalent to the DBPROP_CATALOGLOCATION OLE DB property and which identifies where the catalog name appears within a text string that represents a fully qualified name. This property can be one of the following values:
|
DbpropCatalogTerm |
Read |
|
This string property is equivalent to the DBPROP_CATALOGTERM OLE DB property which lists the term that the server uses to describe a catalog.<126> |
DbpropCatalogUsage |
Read |
|
This property is equivalent to the DBPROP_CATALOGUSAGE OLE DB property. A bitmask that specifies how catalog names can be used in text commands. This property can have a combination of zero or more of the following values:
|
DbpropColumnDefinition |
Read |
|
This property is equivalent to the DBPROP_COLUMNDEFINITION OLE DB property. A bitmask defining the valid clauses for the definition of a column. This property can have a combination of zero or more of the following values:
|
DbpropConcatNullBehavior |
Read |
|
This property is equivalent to the DBPROP_CONCATNULLBEHAVIOR OLE DB property. An enumeration value that indicates how the data source object handles the concatenation of NULL-valued character data type columns with non–NULL-valued character data type columns. This property can have one of the following values:
|
DbpropDataSourceReadOnly |
Read |
|
A Boolean that is equivalent to the DBPROP_DATASOURCEREADONLY OLE DB property. When true, indicates that the data store is read-only; otherwise, false.<130> |
DbpropGroupBy |
Read |
|
This property is equivalent to the OLE DB property DBPROP_GROUPBY. A partial bitmask that indicates the relationship between the columns in a GROUP BY clause and the non-aggregated columns in the select list. The first value in the following list can be used in an OR operation with any of the other values in the list:
|
DbpropHeterogeneousTables |
Read |
|
This property is equivalent to the OLE DB property DBPROP_HETEROGENEOUSTABLES. A bitmask that specifies whether the provider can join tables from different catalogs or providers. This property can be a combination of zero or more of the following values:
|
DbpropIdentifierCase |
Read |
8 |
This property is equivalent to the OLE DB property DBPROP_IDENTIFIERCASE. A bitmask that indicates how identifiers treat case in data definition commands or interfaces. This property can have one of the following values:
|
DbpropMaxIndexSize |
Read |
|
This property is equivalent to the OLE DB property DBPROP_MAXINDEXSIZE. Indicates the maximum number of bytes allowed in the combined columns of an index. If there is no specified limit or the limit is unknown, this value is set to zero.<134> |
DbpropMaxOpenChapters |
Read |
|
This integer property is equivalent to the OLE DB property DBPROP_MAXOPENCHAPTERS. If a chapter is released before a new chapter can be opened, this value is "1"; if the provider has no limit on the number of open chapters or does not support chapters, this value is "0".<135> |
DbpropMaxRowSize |
Read |
|
This integer property is equivalent to the OLE DB property DBPROP_MAXROWSIZE. Indicates the maximum length of a single row in a table. If there is no specified limit or the limit is unknown, this value is set to zero.<136> |
DbpropMaxRowSizeIncludeBlob |
Read |
|
This property is equivalent to the OLE DB property DBPROP_MAXROWSIZEINCLUDESBLOB. A Boolean that, when true, indicates that the maximum row size includes any blob present in the row; otherwise, false.<137> |
DbpropMaxTablesInSelect |
Read |
|
This integer property is equivalent to the OLE DB property DBPROP_MAXTABLESINSELECT. Indicates the maximum number of tables allowed in the FROM clause of a SELECT statement. If there is no specified limit or the limit is unknown, this value is set to zero.<138> |
DbpropMultiTableUpdate |
Read |
|
This Boolean property is equivalent to the OLE DB property DBPROP_MULTITABLEUPDATE. When true, indicates that the provider can do a multitable update; otherwise, false.<139> |
DbpropNullCollation |
Read |
|
This enumeration value is equivalent to the OLE DB property DBPROP_NULLCOLLATION. Indicates where NULLs are sorted in a list. This property can have one of the following values:
|
DbpropOrderByColumnsInSelect |
Read |
|
This Boolean property is equivalent to the OLE DB property DBPROP_ORDERBYCOLUMNSINSELECT. When true, orders by columns in the select list; otherwise, false.<141> |
DbpropOutputParameterAvailable |
Read |
|
This property is equivalent to the OLE DB property DBPROP_OUTPUTPARAMETERAVAILABILITY. It is an integer enumeration that indicates the time at which output parameter values become available. This property can have one of the following values:
|
DbpropPersistentIdType |
Read |
|
This property is equivalent to the OLE DB property DBPROP_PERSISTENTIDTYPE. An integer specifying the type of DBID that the provider uses when persisting DBIDs that name entities in the data store, such as tables, indexes, columns, commands, or constraints. This is generally the type of DBID that the provider considers the most permanent under schema changes and physical data reorganizations. This property can have one of the following values:
|
DbpropPrepareAbortBehavior |
Read |
|
This enumeration value is equivalent to the OLE DB property DBPROP_PREPAREABORTBEHAVIOR. It indicates how aborting a transaction affects prepared commands. This property can have one of the following values:
|
DbpropPrepareCommitBehavior |
Read |
|
This integer enumeration value is equivalent to the OLE DB property DBPROP_PREPARECOMMITBEHAVIOR. It indicates how committing a transaction affects prepared commands. This property can have one of the following values:
|
DbpropProcedureTerm |
Read |
|
This property is equivalent to the OLE DB property DBPROP_PROCEDURETERM. A character string with the data store vendor's name for a procedure - for example, "database procedure", "stored procedure", or "procedure". This is used for building user interfaces.<146> |
DbpropQuotedIdentifierCase |
Read |
|
This enumeration value is equivalent to the OLE DB property DBPROP_QUOTEDIDENTIFIERCASE. It indicates how quoted identifiers treat case. This property can have one of the following values:
|
DbpropSchemaUsage |
Read |
|
This property is equivalent to the OLE DB property DBPROP_SCHEMAUSAGE. A bitmask specifying how schema names can be used in text commands. This property can have a combination of zero or more of the following values:
|
DbpropSqlSupport |
Read |
512 |
This property is equivalent to the OLE DB property DBPROP_SQLSUPPORT. A bitmask specifying the level of support for SQL. This property can have a combination of zero or more of the following values:
|
DbpropSubqueries |
Read |
0 |
This property is equivalent to the OLE DB property DBPROP_SUBQUERIES. A bitmask specifying the predicates in text commands that support subqueries. This property can have a combination of zero or more of the following values:
|
DbpropSupportedTxnDdl |
Read |
|
This property is equivalent to the OLE DB property DBPROP_SUPPORTEDTXNDDL. An integer that indicates the relationship of transactions to table and index modification data definition language (DDL) statements. This property can have one of the following values:
|
DbpropSupportedTxnIsoLevels |
Read |
|
This property is equivalent to the OLE DB property DBPROP_SUPPORTEDTXNISOLEVELS. A bitmask specifying the supported transaction isolation levels. This property can have a combination of zero or more of the following values:
|
DbpropSupportedTxnIsoRetain |
Read |
292 |
This property is equivalent to the OLE DB property DBPROP_SUPPORTEDTXNISORETAIN. A bitmask specifying the supported transaction isolation retention levels. This property can have a combination of zero or more of the following values:
|
DbpropTableTerm |
Read |
|
This property is equivalent to the OLE DB property DBPROP_TABLETERM. A string value that indicates the name the data source object uses for a table - for example, "table" or "file". This property is used for building user interfaces.<154> |
MdpropAggregateCellUpdate<155> |
Read |
|
This property is equivalent to the OLE DB property MDPROP_AGGREGATECELL_UPDATE. An integer enumeration value that indicates support for updating aggregated cells. This property can have one of the following values:
|
MdpropAxes |
Read |
|
This property is equivalent to the OLE DB property MDPROP_AXES. This is an OLE DB for OLAP property. The value of this property is the maximum number of axes that the provider supports in the dataset. To be compliant with OLE DB for OLAP, this value MUST be at least 3.<156> |
MdpropFlatteningSupport |
Read |
|
This property is equivalent to the OLE DB property MDPROP_FLATTENING_SUPPORT. An integer that indicates if a provider supports flattening, and if so, of what type. This property can have one of the following values:
|
MdpropMdxCaseSupport |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_CASESUPPORT. A bitmask that represents the type of CASE statement in MDX that the provider supports. This property can have one of the following values:
|
MdpropMdxDescFlags |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_DESCFLAGS. It is a bitmask that indicates which desc flag values in the DESCENDANTS MDX function are supported by the provider. This property can have a combination of zero or more of the following values:
|
MdpropMdxDrillFunctions |
Read |
|
A bitmask indicating support for drilldown and drillup groups of functions. These functions indicate provider support for drilldown and drillup on tuples as well as members. This property is a combination of zero or more of the following values:
|
MdpropMdxFormulas |
Read |
63 |
This property is equivalent to the OLE DB property MDPROP_MDX_FORMULAS. A bitmask that indicates what support the provider has for the creation of named sets and calculated members. This property can have a combination of zero or more of the following values:
|
MdpropMdxJoinCubes |
Read |
1 |
This property is equivalent to the OLE DB property MDPROP_MDX_JOINCUBES. A bitmask that indicates what support the provider has for queries joining multiple cubes. This property can have a combination of zero or more of the following values:
|
MdpropMdxMemberFunctions |
Read |
15 |
This property is equivalent to the OLE DB property MDPROP_MDX_MEMBER_FUNCTIONS. A bitmask indicating support for various MDX member functions. This property can have a combination of zero or more of the following values:
|
MdpropMdxNonMeasureExpressions |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_NONMEASURE_EXPRESSIONS. An enumeration value that indicates the capabilities in the numeric_value_expression argument of MDX set functions. This property can have one of the following values:
|
MdpropMdxNumericFunctions |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_NUMERIC_FUNCTIONS. A bitmask that indicates support for various numeric functions. This property can have a combination of zero or more of the following values:
|
MdpropMdxObjQualification |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_OBJQUALIFICATION. This property is a bitmask specifying how multidimensional schema object names can be qualified in an MDX statement. This property can have a combination of zero or more of the following values:
|
MdpropMdxOuterReference |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_OUTERREFERENCE. This integer indicates whether <tuple>[.VALUE] can be qualified by <cube_name> in an MDX value expression. 0 means true and 1 means false.<169> |
MdpropMdxQueryByProperty |
Read |
True |
This property is equivalent to the OLE DB property MDPROP_MDX_QUERYBYPROPERTY. A Boolean that, when true, indicates that the provider supports for querying by property values in an MDX statement; otherwise, false.<170> |
MdpropMdxRangeRowset |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_RANGEROWSET. An enumeration value that defines the type of support for cell updates provided by the provider. This property can have one of the following values:
|
MdpropMdxSetFunctions |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_SET_FUNCTIONS. A bitmask that indicates support for various set functions. This property can have a combination of zero or more of the following values:
|
MdpropMdxSlicer |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_SLICER. An enumeration value that indicates the capabilities available in the WHERE clause of an MDX statement. This property can have one of the following values:
|
MdpropMdxStringCompop |
Read |
|
This property is equivalent to the OLE DB property MDPROP_MDX_STRING_COMPOP. A bitmask that indicates support for string comparison operators other than equals and not-equals operators. This property can have a combination of zero or more of the following values:
|
MdpropNamedLevels |
Read |
|
This property is equivalent to the OLE DB property MDPROP_NAMED_LEVELS. A bitmask that indicates support for named levels. This property can have a combination of zero or more of the following values:
|
MDXSupport |
Read |
Core |
An enumeration value that specifies the degree of MDX support. This enumeration has only one value, "Core".<176> |
DbpropMsmdMDXCompatibility |
Read/Write |
0 |
An enumeration value that determines how placeholder members in a ragged or unbalanced hierarchy are treated. This property can have one of the following values:
|
DbpropMsmdSQLCompatibility |
Read/Write |
0 |
Reserved for future use. |
DbpropMsmdMDXUniqueNameStyle |
Read/Write |
0 |
A bitmask that determines the algorithm for generating the unique names of members in a dimension. This property can have a combination of zero or more of the following values:
|
DbpropMsmdCachePolicy |
Read/Write |
|
Reserved for future use. |
DbpropMsmdCacheRatio |
Read/Write |
|
Reserved for future use. |
DbpropMsmdCacheMode |
Read/Write |
|
Reserved for future use. |
DbpropMsmdCompareCaseSensitiveStringFlags |
Read/Write |
1 |
A bitmask that 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 Hindi and Japanese katakana. This property can have a combination of zero or more of the following values:
|
DbpropMsmdCompareCaseNotSensitiveStringFlags |
Read/Write |
69633 |
A bitmask that 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 Hindi and Japanese katakana. This property can have a combination of zero or more of the following values:
|
DbpropMsmdFlattened2 |
Read/Write |
False |
A Boolean property that, when true, 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; otherwise, false. The Level template for output columns is not used. |
DbpropInitMode |
Read/Write |
|
This property is a bitmask specifying access permissions, and is equivalent to the OLE DB property DBPROP_INIT_MODE. The only supported values for this property are DB_MODE_READWRITE (0x03) and DB_MODE_READ (0x01).<177> |
SspropInitAppName |
Read/Write |
|
The name of the client application. |
SspropInitWsid |
Read/Write |
|
The ID of the client workstation. |
SspropInitPacketsize |
Read/Write |
|
The ID of the client application. |
ReadOnlySession |
Read/Write |
|
Reserved for future use. |
SecuredCellValue |
Read/Write |
0 |
An integer enumeration that specifies the error code and the values for the Value and Formatted Value cell properties to be returned when a query tries to access a secured cell. This property can have one of the following values:
|
NonEmptyThreshold |
Read/Write |
|
Reserved for future use. |
SafetyOptions |
Read/Write |
0 |
An enumeration value that determines whether unsafe libraries can be registered and loaded by client applications. This property can have one of the following values:
|
DbpropMsmdCacheRatio2 |
Read/Write |
|
Reserved for future use. |
DbpropMsmdUseFormulaCache |
Read/Write |
|
Reserved for future use. |
DbpropMsmdDynamicDebugLimit |
Read/Write |
|
Reserved for future use. |
DbpropMsmdDebugMode |
Read/Write |
|
Reserved for future use. |
Dialect |
Read/Write |
|
A server SHOULD<178> attempt to deduce the command dialect from the content of the statement element. The dialect property establishes the dialect used in the following situations:
The value of the Dialect property identifies the language used for expressing the statement. The value can be one of the following:
|
ImpactAnalysis |
Write |
False |
When this Boolean is set to true, commands CREATE, ALTER, DELETE, and PROCESS will return a rowset that lists the objects that would be impacted if the command were executed; otherwise, false. |
SQLQueryMode |
Read/Write |
"Calculated" |
An enumeration value that modifies the behavior of calculations which are included in SQL queries. This property can have one of the following values:
|
ClientProcessID |
Read/Write |
0 |
The ID of the client process. |
Cube |
Write |
Empty |
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 an MDX SELECT statement, the setting of this property is ignored. |
ReturnCellProperties |
Read/Write |
False |
A Boolean that, when true, indicates that cell properties are to be returned in query results; otherwise, false. |
CommitTimeout |
Write |
0 |
An integer that determines how long, in seconds, the commit phase of a command waits for locks before rolling back. A value of zero (0) indicates that the instance waits indefinitely. |
ForceCommitTimeout |
Write |
0 |
An integer that determines for how long, in seconds, the commit phase of a command waits before forcing previously issued commands to roll back. A value of zero (0) indicates that the instance waits indefinitely. |
ExecutionMode |
Write |
"Execute" |
Reserved for future use. |
RealTimeOlap |
Read/Write |
False |
A Boolean that, when set to true, indicates that all of the partitions that are listening for table notifications are queried in real time, bypassing caching; otherwise, false. |
MdxMissingMemberMode |
Write |
"Default" |
Indicates how missing members are handled in MDX statements. This property can have one of the following values:
|
CustomData |
Write |
Empty |
A string value that defines a value that will be returned by the customdata() MDX function. |
MdpropMdxSubqueries |
Read |
|
A bitmask that indicates the level of support for subqueries in MDX. This property can have a combination of zero or more of the following values:<179>
|
DbpropMsmdErrorMessageMode |
Write |
2 |
If a cell security MDX expression does not return true or false, but in fact itself returns an error, the integer this property is set to controls what happens. If set to "2", the result returns the error message associated with the error that the evaluation of the cell security expression returns. If this property is set to any other value, the result is treated the same as if the cell security expression evaluated to false, and access to the cell data is denied. This property will be recognized only for administrator connections. |
DisablePrefetchFacts |
Read/Write |
False |
A Boolean that, when true, indicates to the server that it is to disable the prefetching of fact data when executing MDX queries; otherwise, false. By default, the server does prefetch fact data, so the default value for this property, false, leaves the server default in effect. |
UpdateIsolationLevel |
Read/Write |
2 |
An enumeration value that specifies whether the cells in a single UPDATE CUBE are isolated from each other. When the property is set to isolated, the server evaluates each cell update without any consideration for the others, resulting in better performance. This property is a performance hint and is to be used with care. Specifying the property as isolated when the cells actually overlap can produce incorrect results. This property can have one of the following values:
|
MdpropMdxNamedSets |
Read |
15 |
A bitmask that indicates the type of support for named sets. This property can be a combination of zero or more of the following values:
|
DbpropMsmdSubqueries |
Read/Write |
0 |
An enumeration value that determines the behavior of subqueries. This property can have one of the following values:<183>
|
DbpropMsmdAutoExists |
Read/Write |
0 |
Determines the behavior of autoexists. This property can have one of the following values:
|
MdpropMdxDdlExtensions<184> |
Read |
|
A bitmask that indicates one or more of the following:<185>
|
ResponseEncoding<186> |
Read/Write |
"Default" |
Specifies the character encoding to use for the server response to a client request. |
MemoryLockingMode<187> |
Read |
|
The server is able to achieve higher performance if it locks memory. However, users might not have permissions to lock memory. In this case, the server executes in a lower-performance, non-locking, mode. This integer indicates which mode is active:
|
DbpropMsmdOptimizeResponse<188> |
Read/Write |
0 |
A bitmask that indicates which of the following query response optimizations are enabled.
|
DbpropMsmdActivityID |
Read/Write |
|
A string value that can be set by a client on a session to trace multiple query requests to the server.<189> |
DbpropMsmdRequestID |
Read/Write |
|
A string value that can be set by a client on a session to correlate traces from multiple components.<190> |
ReturnAffectedObjects |
Read/Write |
|
This property controls the result of the commands documented in [MS-SSAS-T]. This property is an integer that can be set to cause the current command to return the affected objects.<191> The possible values are as follows.
|
DbpropMsmdRequestMemoryLimit |
Read/Write |
|
This property is used to further constrain the memory allowed to be used for a request by the Memory\QueryMemoryLimit server property value (see section 2.2.4.2.2.2.1). The unit of measure is in kilobytes.<192> |
ApplicationContext |
Read/Write |
|
This property is provided by external applications and is used for end-to-end correlation of user activities.<193> |