UpsQry.IConnexionSql.ListerProcedures

Fonction Habilitation ListerProcedures(NomProprietaire : Nul Ou Caractere=Nul, NomCatalogue : Nul Ou Caractere=Nul, NomSchema : Nul Ou Caractere=Nul, NomProcedure : Nul Ou Caractere=Nul, TTR : Entier=1, ModeOptimisation : ModeOptimisationFlux=Asynchrone4096) Retourner Nul Ou IResultatRequete;

Description

La méthode ListerProcedures permet à la tâche courante de lister les procédures ou les fonctions stockées de la base de données.

Si le nom du propriétaire est précisé dans le paramète NomProprietaire, alors seules les procédures ou les fonctions stockées de ce propriétaire sont remontées.
La fin du nom du propriétaire peut être le caractère joker *. En ce cas, toutes les procédures ou les fonctions stockées des propriétaires dont le nom correspond au modèle sont examinés.

Si le nom du catalogue est précisé dans le paramète NomCatalogue, alors seules les procédures ou les fonctions de ce catalogue sont remontées.
La fin du nom du catalogue peut être le caractère joker *. En ce cas, tous les catalogues dont le nom correspond au modèle sont examinés.

Si le nom du schéma est précisé dans le paramète NomSchema, alors seules les procédures ou les fonctions de ce schéma sont remontées.
La fin du nom du schéma peut être le caractère joker *. En ce cas, tous les schémas dont le nom correspond au modèle sont examinés.

Si le nom de la table est précisé dans le paramète NomProcedure, alors les procédures ou les fonctions ci-dénommées sont remontées.
La fin du nom de la procédure peut être le caractère joker *. En ce cas, toutes les procédures, les fonctions dont le nom correspond au modèle sont examinés.

Si le paramètre TTR spécifiant la taille des tableaux pour les résultats a pour valeur 1, alors les enregistrements sont produits rang après rang. Sinon les enregistrements sont produits par tableau dont la taille est donnée par TTR.
La gestion des tableaux est automatisée pour rendre le principe d'Array Fetch Processing transparent.

Après avoir exécuté la requête sur le dictionnaire de la base de données, Up ! Virtual Technical Machine rècupère tous les enregistrements produits et les conserve dans un espace de mémoire virtuelle dont la taille de l'anté-mémoire est définie par la valeur du paramètre ModeOptimisation. Pour plus de précisions, merci de se référer à la fiche ModeOptimisationFlux.

Cette méthode a deux avantages :

Le format d'un enregistrement résultat est le suivant :

Nom du champType du champDescription du champ
NomProprietaireCaractereNom du propriétaire.
NomCatalogueCaractereNom du catalogue.
NomSchemaCaractereNom du schéma.
NomProcedureCaractereNom de la procédure ou de la fonction.
EstUneFonctionBooleenSi Vrai, il s'agit d'une fonction et non d'une procédure.
NbParametresEntierNombre de paramètres de la procédure ou de la fonction.
CommentaireCaractereCommentaire associé au schéma.

Si la méthode échoue, alors l'exception ErreurOrdreSql est envoyée.

Si la méthode n'est pas supportée, alors le résultat est Nul.

Exemple

Principal
/*******/
Variable
/******/

Debut
...
Si MaConnexionSql.ListerProceduresSupporte Alors ...
Fin Principal

Avertissement

Le pilote de données peut ne pas être en mesure de fournir toutes les informations nécessaires à la constitution d'un enregistrement. En ce cas, certains champs peuvent avoir des valeurs par défaut.

Voir aussi

ListerTables pour lister les tables. ListerColonnesTables pour lister les colonnes d'une table. ListerClesPrimaires pour lister les clés primaires. ListerClesEtrangeres pour lister les clés étrangères. ListerIndex pour lister les index. ListerParametresProcedures pour lister les paramètres d'une procédure. ListerCatalogues pour lister les catalogues. ListerSchemas pour lister les schémas.

ListerProceduresSupporte pour connaître si le listage des procédures est supporté.

Traduction

---------