FireDAC.Comp.DataSet.TFDDataSet.AddIndex

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure AddIndex(const AName, AFields, AExpression: string; AOptions: TFDSortOptions;  const ADescFields: string = ''; const ACaseInsFields: string = ''; ADistinct: Boolean = False);

C++

void __fastcall AddIndex(const System::UnicodeString AName, const System::UnicodeString AFields, const System::UnicodeString AExpression, Firedac::Stan::Intf::TFDSortOptions AOptions, const System::UnicodeString ADescFields = System::UnicodeString(), const System::UnicodeString ACaseInsFields = System::UnicodeString(), bool ADistinct = false);

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet


Description

Crée un nouvel index client pour l'ensemble de données.

Appelez AddIndex pour créer un nouvel index pour l'ensemble de données client. 

Cette méthode signifie ajouter manuellement un nouvel index à la propriété Indexes et définir les propriétés du nouvel index. Si l'index comportant le nom AName existe déjà, une exception est déclenchée.

Les propriétés AField et AExpression sont mutuellement exclusives. Le nouvel index sera actif, mais il ne sera pas l'index en cours.

La signification des paramètres est la suivante :

  • AName - Un nom du nouvel index.
  • AFields - Une liste délimitée par des points virgules des champs à inclure dans l'index.
  • AExpression - Une expression de tri.
  • AOptions - Un ensemble d'options supplémentaires pour l'index.
  • ADescFields - Une liste délimitée par des points virgules des noms de champs. Utilisez ADescFields à la place d'une valeur AOptions incluant soDescending pour créer un index qui trie en ordre croissant selon certains champs et en ordre décroissant selon d'autres. Tous les champs nommés dans ADescFields sont triés dans l'ordre décroissant.
  • ACaseInsFields - Une liste délimitée par des points virgules des noms de champs. Utilisez ACaseInsFields à la place d'une valeur AOptions incluant soNoCase pour créer un index ne tenant pas compte des différences majuscules/minuscules pour certains champs et tenant compte pour d'autres. Tous les champs nommés dans ACaseInsFields sont triés sans tenir compte des différences majuscules/minuscules.
  • ADistinct - True, si vous devez obtenir uniquement les enregistrements comportant les valeurs distinctes AFields / AExpression. False, si vous devez obtenir tous les enregistrements. False est la valeur par défaut.

Voir aussi