Data.DB.TIndexDefs

From RAD Studio API Documentation
Jump to: navigation, search

Data.DB.TDefCollectionSystem.Classes.TOwnedCollectionSystem.Classes.TCollectionSystem.Classes.TPersistentSystem.TObjectTIndexDefs

Delphi

TIndexDefs = class(TDefCollection)

C++

class PASCALIMPLEMENTATION TIndexDefs : public TDefCollection

Properties

Type Visibility Source Unit Parent
class public
Data.DB.pas
Data.DB.hpp
Data.DB Data.DB

Description

TIndexDefs holds the list of available index definitions for a table.

TTable and TClientDataSet components use TIndexDefs to implement their IndexDefs property. These index definitions can be used to obtain information about the indexes defined for the underlying data or, when the component is used to create a table, to create the indexes of that table.

Use the properties and methods of TIndexDefs to:

  • Access a specific index definition.
  • Determine how many index definitions this TIndexDefs object contains.
  • Add or delete index definitions.
  • Copy all index definitions from one TIndexDefs to another.

Note: You cannot use TIndexDef objects in a dataset component's IndexDefs property to add indexes to already existing tables. To do that, use methods such as AddIndex.

See Also