NexusDB

 
Declaration

TnxIndexDescriptor = class(TnxDictionaryItem)

 
Description

An Index Descriptor describes how NexusDB creates an Index for a table. It uses Key Descriptor for creating the record keys and optionally a File Descriptor to describe a sperate file used for storing the index.

 
Methods

CheckValid

This method is called to check the validity of the item. If a descendant needs to validate settings, this method should be overridden and on error raise a an exception.

CreateStandalone

With this constructor an Index descriptor can be created that has NO Data Dictionary as parent.

CreateStandaloneFromReader

With this constructor an Index descriptor can be created that has NO Data Dictionary as parent.

Destroy

destructor.

IsEqual

The IsEqual function should return true if the given aDictionaryItem is of the same type and has *exactly* the same settings. Should be overridden by all descendants.

LoadFromReader

The text for this method has been generated automatically. This means that it is not documented.

SaveStandalone

With this constructor an Index that has NO Data Dictionary as parent can be saved to a separate Writer.

SaveToWriter

The text for this method has been generated automatically. This means that it is not documented.

 
Properties

Desc

A description for the index.

Dups

Set to true if the index allows duplicates.

FileNumber

The file number where the index is stored.

IndexEngine

The Name of the Index Engine used to create access the index.

IndexFile

The File Descriptor if the Index is stored in an extra file.

KeyDescriptor

The Key Descriptor used to create the record keys.

Name

The name of the Index.

Number

The number of the Index in the list of indices of the ParentDataDictionary.

 
File

 
nxsdDataDictionary