Data.SqlExpr.TCustomSQLDataSet.IndexDefs
Delphi
property IndexDefs: TIndexDefs read FIndexDefs write FIndexDefs;
C++
__property Data::Db::TIndexDefs* IndexDefs = {read=FIndexDefs, write=FIndexDefs};
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| property | public | Data.SqlExpr.pas Data.SqlExpr.hpp |
Data.SqlExpr | TCustomSQLDataSet |
Description
Contains the definitions of all indexes defined on the server for the dataset.
Read IndexDefs to obtain information about what indexes are available on the database server for this dataset.
TCustomSQLDataSet does not explicitly use the information in IndexDefs. The order of its records is determined by the ORDER BY clause of its SQL statement.
If the SQL dataset is an instance of TSQLTable, you can use IndexDefs to identify the index to use for the IndexName property. Even with other TCustomSQLDataSet descendants, IndexDefs can be useful for composing SQL commands dynamically that need to use an index on the server. For example, provider components use the index information to uniquely identify records when composing update commands.