Data Source Information Properties

Advantage OLE DB Provider (for ADO)

  Previous topic Next topic  

 

The Advantage OLE DB Provider implements the following properties in the DBPROPSET_DATASOURCEINFO property set. All of these properties are in the Data Source Information property group. These properties are read-only in the Advantage OLE DB Provider and constitute a set of static information about the provider and data store.

Property ID

Description

DBPROP_ACTIVESESSIONS

Type: VT_I4

Typical R/W: Read-only

Description: Active Sessions

Specifies the maximum number of sessions that can exist at the same time. For the Advantage OLE DB Provider, this property is set to 0 because an unlimited number of sessions is supported.

DBPROP_ASYNCTXNABORT

Type: VT_BOOL

Typical R/W: Read-only

Description: Asynchronous Abort

Specifies whether asynchronous abortion of transactions is allowed. For the Advantage OLE DB Provider, this property is set to VARIANT_FALSE because asynchronous operations are not supported.

DBPROP_ASYNCTXNCOMMIT

Type: VT_BOOL

Typical R/W: Read-only

Description: Asynchronous Commit

Specifies whether asynchronous commitment of transactions is allowed. For the Advantage OLE DB Provider, this property is set to VARIANT_FALSE because asynchronous operations are not supported.

DBPROP_BYREFACCESSORS

Type: VT_BOOL

Typical R/W: Read-only

Description: Pass By Ref Accessors

Specifies whether the provider supports the DBACCESSOR_PASSBYREF flag in IAccessor::CreateAccessor. This applies both to row and to parameter accessors. For the Advantage OLE DB Provider, this property is set to VARIANT_FALSE because By Ref accessors are not supported.

DBPROP_CATALOGLOCATION

Type: VT_I4

Typical R/W: Read-only

Description: Indicates the position of the catalog name in a text command. The value for the Advantage OLE DB Provider is DBPROPVAL_CL_START to indicate that the path (if supplied) is at the beginning of the name - for example, "\\server\vol\path\test.adt". Only tables in Free Connections can be qualified with path information.

DBPROP_CATALOGTERM

Type: VT_BSTR

Typical R/W: Read-only

Description: Indicates the name the used for a catalog. With the Advantage OLE DB Provider, the value is either "directory" or "data dictionary" depending on if the connection is a Free Connection or a Database Connection.

DBPROP_CATALOGUSAGE

Type: VT_I4

Typical R/W: Read-only

Description: A bitmask that indicates how catalog names can be used in text commands. With the Advantage OLE DB Provider, the value is DBPROPVAL_CU_DML_STATEMENTS | DBPROPVAL_CU_TABLE_DEFINITION | DBPROPVAL_CU_INDEX_DEFINITION for Free Connections to indicate that the path information can be used with table names in DML (e.g., SELECT) statements as well as table and index definition statements. For Database Connections, the value is 0 because database-bound tables cannot be qualified with path or data dictionary name.

DBPROP_COLUMNDEFINITION

 

Type: VT_I4

Typical R/W: Read-only

Description: Column Definition

A bitmask defining the valid clauses for the definition of a column. For the Advantage OLE DB Provider, this property is set to DBPROPVAL_CD_NOTNULL meaning the "NOT NULL" clause is supported in CREATE TABLE statements.

DBPROP_DATASOURCEREADONLY

Type: VT_BOOL

Typical R/W: Read-only

Description: Read-Only Data Source

For the Advantage OLE DB Provider, this property is set to VARIANT_FALSE because Advantage data sources are always updateable.

DBPROP_DBMSNAME

Type: VT_BSTR

Typical R/W: Read-only

Description: DBMS Name

Specifies the name of the product accessed by the provider. For the Advantage OLE DB Provider, the string is "Advantage Database Server".

DBPROP_DBMSVER

Type: VT_BSTR

Typical R/W: Read-only

Description: DBMS Version

Specifies the version of the product accessed by the provider. For this release of the Advantage OLE DB Provider, the string is "5.70.0000".

DBPROP_DSOTHREADMODEL

Type: VT_I4

Typical R/W: Read-only

Description: Data Source Object Threading Model

Specifies the threading model of the data source object. For the Advantage OLE DB Provider, the value is DBPROPVAL_RT_FREETHREAD.

DBPROP_GROUPBY

Type: VT_I4

Typical R/W: Read-only

Description: Group By Support

Specifies the relationship between the columns in a GROUP BY clause and the nonaggregated columns on a select list. For the Advantage OLE DB Provider, the value is DBPROPVAL_GB_CONTAINS_SELECT, which indicates that the GROUP BY clause must contain all nonaggregated columns in the select list. It can also contain columns that are not on the select list.

DBPROP_HETEROGENEOUSTABLES

Type: VT_I4

Typical R/W: Read-only

Description: Heterogeneous Table Support

Specifies whether the provider can join tables from different catalogs or providers. For the Advantage OLE DB Provider, the value is zero because the provider can't join across providers or catalogs.

DBPROP_MAXINDEXSIZE

Type: VT_I4

Typical R/W: Read-only

Description: Maximum Index Size

Specifies the maximum number of bytes allowed in the combined columns of an index. The maximum index key length is 4082 bytes for ADI indexes, 240 bytes for CDX and IDX indexes, and 256 bytes for NTX indexes.

DBPROP_MAXOPENCHAPTERS

Type: VT_I4

Typical R/W: Read-only

Description: Indicates the maximum number of chapters that can be open at any time.

For the Advantage OLE DB provider, the value is 0, which means that there is no limit on the number of chapters that can be open at any one time.

DBPROP_MAXROWSIZE

Type: VT_I4

Typical R/W: Read-only

Description: Maximum Row Size

Specifies the maximum length of a single row in a table. For the Advantage OLE DB Provider, the value is 65535.

DBPROP_MAXROWSIZEINCLUDESBLOB

Type: VT_BOOL

Typical R/W: Read-only

Description: Maximum Row Size Includes BLOB

For the Advantage OLE DB Provider, the value is always VARIANT_FALSE, which indicates that the maximum row size returned for the DBPROP_MAXROWSIZE property does not include the length of all BLOB data.

DBPROP_MAXTABLESINSELECT

Type: VT_I4

Typical R/W: Read-only

Description: Maximum Tables in SELECT

Specifies the maximum number of tables allowed in the FROM clause of a SELECT statement. For the Advantage OLE DB Provider, the value is always zero because there is no limit.

DBPROP_MULTIPLEPARAMSETS

Type: VT_BOOL

Typical R/W: Read-only

Description: Multiple Parameter Sets

For the Advantage OLE DB Provider, the value is always VARIANT_FALSE, which indicates the provider supports only a single set of parameters per execution.

DBPROP_MULTIPLERESULTS

Type: VT_I4

Typical R/W: Read-only

Description: Multiple Results

For the Advantage OLE DB Provider, this property is set to DBPROPVAL_MR_NOTSUPPORTED because multiple result sets are not supported.

DBPROP_MULTIPLESTORAGEOBJECTS

Type: VT_BOOL

Typical R/W: Read-only

Description: Multiple Storage Objects

Specifies wither the provider supports multiple open storage objects at the same time. For the Advantage OLE DB Provider, this property is set to VARIANT_TRUE meaning the provider supports multiple open storage objects at the same time.

DBPROP_MULTITABLEUPDATE

Type: VT_BOOL

Typical R/W: Read-only

Description: Multi-Table Update

For the Advantage OLE DB Provider, the value is always VARIANT_FALSE, which indicates the provider cannot update rowsets derived from multiple tables.

DBPROP_NULLCOLLATION

Type: VT_I4

Typical R/W: Read-only

Description: NULL Collation Order

For the Advantage OLE DB Provider, the value is always DBPROPVAL_NC_LOW, which indicates that null values are sorted at the low end of the list.

DBPROP_OLEOBJECTS

 

Type: VT_I4

Typical R/W: Read-only

Description: OLE Object Support

A bitmask specifying the ways in which the provider supports access to BLOBs and COM objects stored in columns. For the Advantage OLE DB Provider, this property is set to DBPROPVAL_OO_BLOB meaning the provider supports access to BLOBs as structured storage objects. A consumer determines what interfaces are supported through DBPROP_STRUCTUREDSTORAGE.

DBPROP_OPENROWSETSUPPORT

Type: VT_I4

Typical R/W: Read-only

Description: Open Rowset Support

For the Advantage OLE DB Provider, the value is DBPROPVAL_ORS_INTEGRATEDINDEX because both a table and an index can be specified in the same call to IopenRowset::OpenRowset in order to open the rowset using the specified index.

DBPROP_ORDERBYCOLUMNSINSELECT

Type: VT_I4

Typical R/W: Read-only

Description: Order By Columns in Select List

For the Advantage OLE DB Provider, the value is always VARIANT_FALSE, which indicates that columns in an ORDER BY clause are not required to be on the select list.

DBPROP_OUTPUTPARAMETERAVAILABILITY

Type: VT_I4

Typical R/W: Read-only

Description: Output Parameter Availability

For the Advantage OLE DB Provider, the value is always DBPROPVAL_OA_NOTSUPPORTED, which indicates that output parameters are not supported.

DBPROP_PREPAREABORTBEHAVIOR

Type: VT_I4

Typical R/W: Read-only

Description: Prepare Abort Behavior

Specifies how aborting a transaction affects prepared commands. For the Advantage OLE DB Provider, the value is always DBPROPVAL_CB_PRESERVE because aborting a transaction preserves prepared commands. The application can re-execute commands without re-preparing them.

DBPROP_PREPARECOMMITBEHAVIOR

Type: VT_I4

Typical R/W: Read-only

Description: Prepare Commit Behavior

Specifies how committing a transaction affects prepared commands. For the Advantage OLE DB Provider, the value is always DBPROPVAL_CB_PRESERVE because committing a transaction preserves prepared commands. The application can re-execute commands without re-preparing them.

DBPROP_PROCEDURETERM

Type: VT_BSTR

Typical R/W: Read-only

Description: Procedure Term

For the Advantage OLE DB Provider, the string is NULL because Advantage does not currently support stored procedures.

DBPROP_PROVIDERFRIENDLYNAME

Type: VT_BSTR

Typical R/W: Read-only

Description: Provider Friendly Name

For the Advantage OLE DB Provider, the string is "Advantage OLE DB Provider".

DBPROP_PROVIDERMEMORY

Type: VT_BOOL

Typical R/W: Read-only

Description: Provider Owned Memory

For the Advantage OLE DB Provider, the value is always VARIANT_FALSE because provider-owned memory is not supported.

DBPROP_PROVIDERNAME

Type: VT_BSTR

Typical R/W: Read-only

Description: Provider Name

Specifies the file name of the provider. For the Advantage OLE DB Provider, the string is "ADSOLEDB.DLL".

DBPROP_PROVIDEROLEDBVER

Type: VT_BSTR

Typical R/W: Read-only

Description: OLE DB Version

Returns the version of OLE DB supported by the provider. The version is returned in the format ##.## ####, where the first two digits are the major version, the next two digits are the minor version, and the last four digits are the release version. For the Advantage OLE DB Provider, the string is "02.10".

DBPROP_PROVIDERVER

Type: VT_BSTR

Typical R/W: Read-only

Description: Provider Version

Indicates the version of the provider. The version is of the form ##.##.####, where the first two digits are the major version, the next two digits are the minor version, and the last four digits are the release version. The provider can append a description of the provider. For the Advantage OLE DB Provider, the string is "01.00.0000".

DBPROP_QUOTEDIDENTIFIERCASE

Type: VT_I4

Typical R/W: Read-only

Description: Quoted Identifier Sensitivity

For the Advantage OLE DB Provider, this property is set to DBPROPVAL_IC_MIXED, which indicates that identifiers quoted in SQL are case-insensitive.

DBPROP_ROWSETCONVERSIONCOMMAND

Type: VT_BOOL

Typical R/W: Read-only

Description: Rowset Conversions On Command

For the Advantage OLE DB Provider, the value is always VARIANT_TRUE, which indicates that callers to IconvertType::CanConvert can inquire on a command about conversions supported on rowsets generated by the command.

DBPROP_SCHEMAUSAGE

Type: VT_I4

Typical R/W: Read-only

Description: Schema Usage

A bitmask specifying how schema names can be used in text commands. For the Advantage OLE DB Provider, the value is always zero because schema names are not supported in SQL statements.

DBPROP_SQLSUPPORT

 

Type: VT_I4

Typical R/W: Read-only

Description: SQL Support

Specifies a bitmask that indicates the level of support for SQL. For the Advantage OLE DB Provider, the value is always DBPROPVAL_SQL_ODBC_MINIMUM | DBPROPVAL_SQL_ESCAPECLAUSES.

DBPROP_STRUCTUREDSTORAGE

 

Type: VT_I4

Typical R/W: Read-only

Description: Structured Storage

A bitmask specifying what interfaces the rowset supports on storage objects. For the Advantage OLE DB Provider, this property is set to DBPROPVAL_SS_ISEQUENTIALSTREAM meaning the provider supports the ISequentialStream structured storage interface (only).

DBPROP_SUBQUERIES

Type: VT_I4

Typical R/W: Read-only

Description: Subquery Support

Specifies a bitmask that indicates the predicates in text commands that support subqueries. For the Advantage OLE DB Provider, this property is set to DBPROPVAL_SQ_CORRELATEDSUBQUERIES | DBPROPVAL_SQ_COMPARISON | DBPROPVAL_SQ_EXISTS | DBPROPVAL_SQ_IN | DBPROPVAL_SQ_QUANTIFIED.

DBPROP_SUPPORTEDTXNDDL

Type: VT_I4

Typical R/W: Read-only

Description: Transaction DDL

Specifies whether Data Definition Language (DDL) statements are supported in transactions. For the Advantage OLE DB Provider, the value is always DBPROPVAL_TC_DDL_IGNORE because most DDL statements will be allowed to occur, but will be ignored by the transaction in that those DDL statements occur immediately and cannot be rolled back. Some DDL statements will cause an error when performed within a transaction, however. See Transaction Processing System for detailed information on which DDL statements are ignored and which ones cause errors.

DBPROP_SUPPORTEDTXNISOLEVELS

Type: VT_I4

Typical R/W: Read-only

Description: Isolation Levels

Specifies a bitmask that indicates the supported transaction isolation levels. For the Advantage OLE DB Provider, this value is always DBPROPVAL_TI_READCOMMITTED (which is the same value as DBPROPVAL_TI_CURSORSTABILITY) because Read Committed is the only transaction isolation level supported.

DBPROP_SUPPORTEDTXNISORETAIN

Type: VT_I4

Typical R/W: Read-only

Description: Isolation Retention

Specifies a bitmask that indicates the supported transaction isolation retention levels. For the Advantage OLE DB Provider, the value is DBPROPVAL_TR_NONE | DBPROPVAL_TR_ABORT_NO | DBPROPVAL_TR_COMMIT_NO because isolation is not retained across commits/aborts.

DBPROP_TABLETERM

Type: VT_BSTR

Typical R/W: Read-only

Description: Table Term

Specifies the name the data store uses for a table. For the Advantage OLE DB Provider, the string is "table".

DBPROP_USERNAME

 

Type: VT_BSTR

 

Typical R/W: Read-only

 

Description: User Name

A character string with the name used in a particular database. For the Advantage OLE DB Provider, this property is set to the name of the user who is logged into the database (Advantage Data Dictionary).