Datasnap.DBClient.TCustomClientDataSet.AddIndex

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

procedure AddIndex(const Name, Fields: string; Options: TIndexOptions;  const DescFields: string = ''; const CaseInsFields: string = ''; const GroupingLevel: Integer = 0);

C++

void __fastcall AddIndex(const System::UnicodeString Name, const System::UnicodeString Fields, Data::Db::TIndexOptions Options, const System::UnicodeString DescFields = System::UnicodeString(), const System::UnicodeString CaseInsFields = System::UnicodeString(), const int GroupingLevel = 0x0);

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
procedure
function
public
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Datasnap.DBClient TCustomClientDataSet

Beschreibung

Erstellt einen neuen Index für die Client-Datenmenge.

Mit AddIndex können Sie einen neuen Index für die Client-Datenmenge erstellen.

Name gibt den Namen des Index an.

Fields ist eine Liste der in den Index aufzunehmenden Felder. Die Feldnamen werden durch ein Semikolon getrennt.

Options ist eine gegebenenfalls leere Menge, die bis zu zwei TIndexOptions-Werte enthalten kann. Die gültigen Elemente dieser Menge sind ixDescending (Index wird alphanumerisch absteigend sortiert) und ixCaseInsensitive (beim Sortieren bleibt die Groß-/Kleinschreibung unberücksichtigt).

Warnung:  AddIndex löst eine Exception aus, wenn Sie einen Index mit anderen TIndexOptions-Werten erstellen.

DescFields ist eine Liste der Feldnamen, die durch Semikolons voneinander getrennt sind. Verwenden Sie DescFields anstelle eines Options-Werts mit ixDescending, um einen Index zu erstellen, der für einige Felder auf- und für andere Felder absteigend sortiert. Alle in DescFields angegebenen Felder werden in absteigender Folge sortiert.

CaseInsFields ist eine Liste von Feldnamen, die durch Semikolons voneinander getrennt sind. Verwenden Sie CaseInsFields anstelle eines Options-Werts mit ixCaseInsensitive, um einen Index zu erstellen, der für einige Felder die Groß-/Kleinschreibung berücksichtigt, für andere dagegen nicht. Alle in CaseInsFields angegebenen Felder werden ohne Berücksichtigung der Schreibweise sortiert.

GroupingLevel ist die vom Index unterstützte Standardgruppierungsebene. Wenn die Client-Datenmenge diesen Index verwendet, sind die Gruppierungsinformationen automatisch für Untergruppen verfügbar, die von bis zu GroupingLevel Feldern im Index definiert werden. (Wenn die Client-Datenmenge gewartete Aggregate verwendet, werden Informationen über tiefer verschachtelte Gruppen gegebenenfalls verfügbar, wenn die Aggregate auf einer Gruppierungsebene definiert sind, die größer als der Standardwert für den Index ist). GroupingLevel kann jeden Wert zwischen 0 und der Anzahl der Felder im Index annehmen.

Anmerkung:  Mit AddIndex hinzugefügte Indizes werden nicht mit den Daten gespeichert, wenn Sie SaveToFile verwenden. Sie bleiben daher nach dem Schließen der Datenmenge nicht erhalten (d. h. sie sind beim erneuten Öffnen der Client-Datenmenge nicht mehr vorhanden). Sie können AddIndex nicht aufrufen, während die Datenmenge geschlossen ist.

Tip:  Die Unterstützung gewarteter Aggregate ist in Indizes möglich, die mit AddIndex hinzugefügt werden.

Siehe auch

Codebeispiele