IEtlPlainIndex.Description

Syntax

Description: String;

Description

The Description property determines description (annotation) of data source index.

Example

Sub UserProc;
Var
    MB: IMetabase;
    Object: IMetabaseObject;
    EtlTask: IEtlTask;
    Join: IEtlPlainDataJoin;
    Index: IEtlPlainIndex;
    s: String;
Begin
    MB := MetabaseClass.Active;
    Object := MB.ItemById("ETL").Edit;
    EtlTask := Object As IEtlTask;
    Join := EtlTask.Item(2) As IEtlPlainDataJoin;
    Index := Join.Index;
    s := Index.Description;
End Sub UserProc;

After executing the example the "s" variable contains description of an index of the third ETL task object. The type of ETL task object is Join. The repository object has the ETL identifier.