MDAC 2.5 SDK - OLE DB Providers
OLE DB Provider for Microsoft Jet


 

Index Properties

The DBPROPSET_INDEX property set contains the following properties. All of these properties are in the Index property group.

Property ID Description
DBPROP_INDEX_AUTOUPDATE Type: VT_BOOL

Typical R/W: R only

Description: Auto Update

Specifies whether the index is maintained automatically when changes are made to the corresponding base table.

For this provider, the value is always VARIANT_TRUE, which indicates that the index is automatically maintained.

DBPROP_INDEX_CLUSTERED Type: VT_BOOL

Typical R/W: R only

Description: Clustered

Specifies whether an index is clustered.

  • For this provider, the value is always VARIANT_FALSE, which indicates that the leaf nodes of the index contain bookmarks relating to the base table rows whose key values match the key values of the index entry.
DBPROP_INDEX_FILLFACTOR Type: VT_BSTR

Typical R/W: R only

Description: Fill Factor

For a B+- tree index, this property represents the storage use of page nodes during the creation of the index. The value is an integer, from 1 to 100, that represents the percentage of use of an index node. For a linear hash index, this property represents the storage use of the entire hash structure (the ratio of the used area to the total allocated area) before expansion of file structures occurs. This value is always 100 in the OLE DB Provider for Microsoft Jet.

DBPROP_INDEX_INITIALSIZE Type: VT_I4

Typical R/W: R only

Description: Initial Size

Specifies the total number of bytes allocated to this structure at creation time.

For this provider, the value is based on the following:

  • One page = 4096 bytes
DBPROP_INDEX_NULLCOLLATION Type: VT_I4

Typical R/W: R only

Description: NULL Collation

  • Specifies how null values are collated in the index.

  • For this provider, the value is always DBPROPVAL_NC_LOW, which indicates that null values are collated at the low end of the list.
DBPROP_INDEX_NULLS Type: VT_I4

Typical R/W: R/W

Description: NULL Keys

Specifies whether null keys are allowed.

  • For this provider, the following three values are valid:

  • DBPROPVAL_IN_ALLOWNULL— The index allows entries where the key columns are NULL and sorts according to the collation described by DBPROP_INDEX_NULLCOLLATION.

  • DBPROPVAL_IN_DISALLOWNULL—The index does not allow entries where the key columns are NULL. If the consumer attempts to insert an index entry with a NULL key, the provider returns an error.

  • DBPROPVAL_IN_IGNORENULL—The index does not insert entries containing NULL keys. If the consumer attempts to insert an index entry with a NULL key, the provider ignores that entry and no error code is returned.
DBPROP_INDEX_PRIMARYKEY Type: VT_BOOL

Typical R/W: R/W

Description: Primary Key

Specifies whether the index represents the primary key on the table.

DBPROP_INDEX_SORTBOOKMARKS Type: VT_BOOL

Typical R/W: R only

Description: Sort Bookmarks

Specifies how the index treats repeated keys.

  • For this provider, the value is always VARIANT_FALSE, which indicates that the index does not sort repeated keys by bookmark.
DBPROP_INDEX_TEMPINDEX Type: VT_BOOL

Typical R/W: R only

Description: Temporary Index

Specifies whether the index is temporary, that is:

  • VARIANT_FALSE, which indicates that the index is permanent.
DBPROP_INDEX_TYPE Type: VT_I4

Typical R/W: R only

Description: Index Type

Specifies the type of the index.

  • For this provider, the value is always DBPROPVAL_IT_BTREE, which indicates that the index is a B+- tree.
DBPROP_INDEX_UNIQUE Type: VT_BOOL

Typical R/W: R/W

Description: Unique

Specifies whether index keys must be unique. One of the following:

  • VARIANT_TRUE, which indicates that the index keys must be unique.

  • VARIANT_FALSE, which indicates that duplicate keys are allowed.