IBX.IBExtract.TIBExtract.ExtractObject

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

procedure ExtractObject(ObjectType : TExtractObjectType; ObjectName : String = '';  {do not localize}  ExtractTypes : TExtractTypes = []);

C++

void __fastcall ExtractObject(TExtractObjectType ObjectType, System::UnicodeString ObjectName = System::UnicodeString(), TExtractTypes ExtractTypes = TExtractTypes() );

Propriétés

Type Visibilité  Source Unité  Parent
procedure
function
public
IBX.IBExtract.pas
IBX.IBExtract.hpp
IBX.IBExtract TIBExtract

Description

Récupère les métadonnées spécifiées sur le serveur InterBase et les écrit dans la propriété Items.

Appelez ExtractObject pour récupérer les métadonnées à partir de la base de données spécifiée par la propriété Database et les écrire dans la propriété Items.

ObjectType indique le type de métadonnées souhaité. Sa signification est modifiée par les paramètres ObjectName et ExtractTypes, tels que spécifiés dans le tableau suivant :


Valeur Signification

eoDatabase

Enumère tous les objets définis sur la base de données. Il s'agit de la liste récupérable en appelant ExtractObject pour chaque autre type d'objet (plus la commande de création de base de données gérée), sans limite imposée par les paramètres ObjectName et ExtractTypes.|-

eoDomain

Enumère tous les domaines. Si ExtractTypes inclut etTable, cette liste comporte uniquement les domaines de la table spécifiée par ObjectName.

eoTable

Si ObjectName est une chaîne vide, énumère toutes les tables définies sur le serveur. Si ObjectName n'est pas vide, énumère toutes les colonnes et tous les types de la table nommée par ObjectName, plus toutes les informations spécifiées par ExtractTypes qui appartiennent à cette table : domaines (etDomain), index (etIndex), contraintes de clé étrangère (etForeign), contraintes de vérification (etCheck), déclencheurs (etTrigger), autorisations des utilisateurs (etGrant) et données (etData).

eoView

Si ObjectName est une chaîne vide, énumère le texte de toutes les vues. Sinon, énumère le texte de la vue nommée par le paramètre ObjectName.

eoProcedure

Si ObjectName est une chaîne vide, énumère toutes les procédures stockées. Sinon, énumère le texte de la procédure stockée nommée par le paramètre ObjectName. Lorsque les procédures se référencent mutuellement, ExtractObject crée des procédures factices du nom correct, puis leur attribue la fiche correcte. Si ExtractTypes inclut etAlterProc, seule la fiche corrigée est récupérée.

eoFunction

Enumère toutes les fonctions externes. Si ObjectName n'est pas vide, la liste est filtrée pour ne comporter que les fonctions qui correspondent au nom spécifié.

eoGenerator

Enumère tous les générateurs non système. Si ObjectName n'est pas vide, la liste est filtrée pour ne comporter que les générateurs qui correspondent au nom spécifié.

eoException

Enumère toutes les exceptions définies par la base de données. Si ObjectName n'est pas vide, la liste est filtrée pour ne comporter que les exceptions qui correspondent au nom spécifié.

eoBLOBFilter

Enumère tous les filtres blob. Si ObjectName n'est pas vide, la liste est filtrée pour ne comporter que les filtres dont le nom de la fonction correspond au nom spécifié.

eoRole

Enumère tous les rôles. Si ObjectName n'est pas vide, la liste est filtrée pour ne comporter que les rôles dont le nom correspond à la chaîne spécifiée.

eoTrigger

Si ExtractTypes inclut etTable, énumère tous les déclencheurs définis pour la table spécifiée par ObjectName. Sinon, énumère tous les déclencheurs ou, si ObjectName n'est pas vide, tous les déclencheurs qui correspondent à la chaîne spécifiée par ObjectName.

eoForeign

Si ExtractTypes inclut etTable, énumère toutes les contraintes de clé primaire qui appartiennent à la table spécifiée par ObjectName. Sinon, énumère toutes les contraintes de clé primaire ou, si ObjectName n'est pas vide, toutes les contraintes de clé primaire dont le nom correspond à ObjectName.

eoIndexes

Si ExtractTypes inclut etTable, énumère tous les index définis pour la table spécifiée par ObjectName. Sinon, énumère tous les index ou, si ObjectName n'est pas vide, tous les index dont le nom correspond à ObjectName.

eoChecks

Si ExtractTypes inclut etTable, énumère toutes les contraintes de vérification non étrangères définies pour la table spécifiée par ObjectName. Sinon, énumère toutes les contraintes de vérification non étrangères ou, si ObjectName n'est pas vide, toutes les contraintes de vérification dont le nom correspond à ObjectName.

eoData

Enumère toutes les données de l'objet nommé par le paramètre ObjectName.


ObjectName indique le nom d'un objet (tel qu'une table ou une procédure stockée) dont vous voulez récupérer les informations. Le type de cet objet et la limite imposée sur les informations récupérées dépendent des valeurs de ObjectType et ExtractTypes.

ExtractTypes modifie l'interprétation d'ObjectType, pour filtrer le type d'informations récupérées.