Data.DB.TIndexDef.Options

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Options: TIndexOptions read FOptions write SetOptions default [];

C++

__property TIndexOptions Options = {read=FOptions, write=SetOptions, default=0};

Properties

Type Visibility Source Unit Parent
property published
Data.DB.pas
Data.DB.hpp
Data.DB TIndexDef

Description

Describes the characteristics of the index.

When creating a new index, use Options to specify the attributes of the index. Options can contain zero or more of the TIndexOption constants ixPrimary, ixUnique, ixDescending, ixCaseInsensitive, and ixExpression.

When inspecting the definitions of existing indexes, read Options to determine the option(s) used to create the index.

Note: Different database drivers may support only a subset of these options. For example, with dBASE tables, ixCaseInsensitive is not supported. Including an option that is not valid for a table will raise an exception.

Note: Primary indexes are, by definition unique. If setting the Options value ixPrimary, you need not also use ixUnique.

See Also

Code Examples