Package Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Représente le conteneur du colis. Cette classe ne peut pas être héritée.
public ref class Package sealed : Microsoft::SqlServer::Dts::Runtime::EventsProvider, Microsoft::SqlServer::Dts::Runtime::IDTSConfigurationControl, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx, Microsoft::SqlServer::Dts::Runtime::IDTSSequence
public sealed class Package : Microsoft.SqlServer.Dts.Runtime.EventsProvider, Microsoft.SqlServer.Dts.Runtime.IDTSConfigurationControl, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx, Microsoft.SqlServer.Dts.Runtime.IDTSSequence
type Package = class
inherit EventsProvider
interface IDTSSequence
interface IDTSPropertiesProvider
interface IDTSPropertiesProviderEx
interface IDTSPackagePath
interface IDTSExecutionPath
interface IDTSConfigurationControl
Public NotInheritable Class Package
Inherits EventsProvider
Implements IDTSConfigurationControl, IDTSExecutionPath, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSSequence
- Héritage
- Implémente
Remarques
Le package est un ensemble d’autres conteneurs, connexions, tâches, transformations, variables, configurations et contraintes de précédence. Les paquets peuvent être créés de manière programmatique ou en utilisant l’outil graphique SSIS Designer. Les paquets peuvent être sauvegardés à différents endroits, y compris Microsoft SQL Server ou un fichier XML.
Pour plus d’informations sur les paquets, voir Paquets des Services d’Intégration (SSIS).
Constructeurs
| Nom | Description |
|---|---|
| Package() |
Initialise une nouvelle instance de la classe Package. |
Champs
| Nom | Description |
|---|---|
| m_executable |
L’exécutable. (Hérité de Executable) |
Propriétés
| Nom | Description |
|---|---|
| CertificateContext |
Obtient ou définit l’objet certificat X.509 pour le package. |
| CertificateObject |
Obtient ou définit l’objet certificat X.509 pour le package. |
| CheckpointFileName |
Obtient ou définit le nom du fichier qui capture les informations du point de contrôle, ce qui permet à un package de redémarrer. |
| CheckpointUsage |
Obtient ou définit une valeur qui spécifie si ou quand un package est redémarré. |
| CheckSignatureOnLoad |
Obtient ou définit une valeur indiquant si la signature numérique est vérifiée lors du chargement d’un paquet. |
| Configurations |
Obtient la collection de configurations pour le package. Un package peut avoir plus d’une configuration associée. Cette propriété est en lecture seule. |
| Connections |
Il obtient la collection de gestionnaires de connexions pour le paquet. |
| CreationDate |
Reçoit ou fixe la date et l’heure de création du paquet. |
| CreationName |
Retourne la chaîne utilisée pour créer une instance de l’objet DtsContainer . Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| CreatorComputerName |
Obtient ou définit le nom de l’ordinateur sur lequel le paquet a été créé. |
| CreatorName |
Obtient ou définit le nom de la personne qui a créé le paquet. |
| DebugMode |
Obtient ou définit un Booléen qui indique si l’objet DtsContainer est en mode débogage et s’il doit déclencher l’événement OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) pendant l’exécution. (Hérité de DtsContainer) |
| DelayValidation |
Obtient ou définit un booléen qui indique si la validation de la tâche est retardée jusqu’au moment de l’exécution. La valeur par défaut est false. (Hérité de DtsContainer) |
| Description |
Obtient ou définit la description de l’objet DtsContainer . (Hérité de DtsContainer) |
| DesignEvents |
Obtient ou définit un IDTSEvents élément qui indique si le concepteur ou un autre client tiers doit recevoir des événements pendant la période de conception. |
| DesignTimeProperties |
Obtient ou définit les propriétés du temps de conception d’un paquet, telles que les informations de mise en page. |
| Disable |
Un booléen qui indique si l’objet DtsContainer est désactivé. (Hérité de DtsContainer) |
| DisableEventHandlers |
Obtient ou définit un Booléen qui indique si les gestionnaires d’événements sur la tâche sont désactivés. (Hérité de EventsProvider) |
| DumpDescriptor |
Précisez quand un fichier de vidage doit être généré. |
| DumpOnAnyError |
Spécifiez si un fichier de vidage doit être généré lorsqu’une erreur survient lors de l’exécution du paquet. |
| EnableConfigurations |
Obtient ou définit une valeur qui indique si le package charge des configurations. |
| EnableDump |
Spécifiez si la génération de fichiers de vidage est activée. |
| EncryptCheckpoints |
Obtient ou définit une valeur qui indique si les fichiers de points de contrôle sont chiffrés. |
| Errors |
Obtient la collection d’erreurs associées au paquet. Ce champ est en lecture seule. |
| EventHandlers |
Retourne une collection d’objets gestionnaires d’événements. Ce champ est en lecture seule. (Hérité de EventsProvider) |
| EventInfos |
Retourne une collection d’objets EventInfo . Ce champ est en lecture seule. (Hérité de EventsProvider) |
| Executables |
Obtient la collection d’objets exécutables contenus dans le paquet qui font partie du flux de travail du paquet. |
| ExecutionDuration |
Retourne une valeur qui indique le temps que le conteneur a passé en exécution, en millisecondes. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| ExecutionResult |
Retourne une valeur qui indique le succès ou l’échec de l’exécution de l’objet DtsContainer . (Hérité de DtsContainer) |
| ExecutionStatus |
Retourne une valeur qui indique le statut actuel de l’exécution de l’objet DtsContainer au moment de l’appel. (Hérité de DtsContainer) |
| ExtendedProperties |
Ça prend la ExtendedProperties collection du colis. |
| FailPackageOnFailure |
Obtient ou définit une valeur qui indique si le package échoue lorsqu’une tâche ou un composant du package échoue. |
| FailParentOnFailure |
Obtient ou définit un |
| ForcedExecutionValue |
Si la ForceExecutionValue propriété est définie sur True, obtient ou définit une valeur qui spécifie la valeur d’exécution optionnelle que le package retourne. (Hérité de DtsContainer) |
| ForceExecutionResult |
Obtient ou définit une DTSForcedExecResult valeur d’énumération qui spécifie le résultat d’exécution forcée du conteneur. (Hérité de DtsContainer) |
| ForceExecutionValue |
Obtient ou définit un booléen qui indique si la valeur d’exécution du conteneur doit être forcée à contenir une valeur particulière. (Hérité de DtsContainer) |
| HasExpressions |
Obtient une valeur qui indique si le paquet contient des expressions. |
| ID |
Retourne l’ID, qui est un GUID, du DtsContainer. La valeur est en lecture seule. (Hérité de DtsContainer) |
| IgnoreConfigurationsOnLoad |
Obtient ou définit une valeur qui indique si le package ignore les configurations lors du chargement. |
| InteractiveMode |
Obtient ou définit une valeur qui indique si les tâches doivent afficher des objets d’interface utilisateur lors de l’exécution. |
| IsDefaultLocaleID |
Un booléen qui indique si le conteneur utilise la localisation par défaut. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| IsolationLevel |
Obtient ou définit le niveau d’isolation de la transaction dans l’objet DtsContainer . (Hérité de DtsContainer) |
| LocaleID |
Obtient ou définit un entier qui indique l’identifiant de localisation Microsoft Win32® à utiliser lors de l’exécution de l’objetDtsContainer. (Hérité de DtsContainer) |
| LogEntryInfos |
Renvoie un objet LogEntryInfos. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| LoggingMode |
Obtient ou définit une valeur valide de l’énumération DTSLoggingMode qui indique le mode de journalisation du conteneur. (Hérité de DtsContainer) |
| LoggingOptions |
Retourne un objet contenant des propriétés indiquant la ressource de filtrage et de journalisation pour les conteneurs. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| LogProviders |
Obtient la collection de fournisseurs de journaux associés au paquet. |
| MaxConcurrentExecutables |
Obtient ou définit le nombre de threads qu’un package peut créer. |
| MaximumErrorCount |
Obtient ou définit une valeur entière qui indique le nombre maximal d’erreurs pouvant survenir avant que l’objet DtsContainer ne cesse de fonctionner. (Hérité de DtsContainer) |
| Name |
Obtient ou définit le nom du DtsContainer. (Hérité de DtsContainer) |
| OfflineMode |
Obtient ou définit une valeur qui indique si le package fonctionne en mode hors ligne. |
| PackagePassword |
Définit la valeur du mot de passe du colis. Cette propriété est en écriture seule. |
| PackagePriorityClass |
Spécifie la classe de priorité du thread Win32 du thread du package. |
| PackageType |
Spécifie une valeur qui identifie l’outil qui a créé le package. |
| PackageUpgradeOptions |
Obtient ou définit les options de mise à niveau pour le forfait. |
| Parameters |
Obtient la collecte des paramètres pour le paquet. |
| Parent |
Il retourne le conteneur parent. La valeur est en lecture seule. (Hérité de DtsContainer) |
| PrecedenceConstraints |
Obtient la collection des PrecedenceConstraint objets. Ce champ est en lecture seule. |
| Project |
Obtient ou définit le projet spécifié associé au package. |
| Properties |
Obtient la collection de l’objet DtsProperties pour le paquet. |
| ProtectionLevel |
Ça a le niveau de protection du paquet. |
| SafeRecursiveProjectPackageExecution |
Obtient ou définit une valeur qui indique si l’exécution récursive du paquet est sûre. |
| SaveCheckpoints |
Obtient ou définit une valeur qui indique si le package utilisera des points de contrôle lors de l’exécution du package. |
| Site |
Obtient ou règle le site du conteneur. (Hérité de DtsContainer) |
| StartTime |
Indique l’heure à laquelle le conteneur a commencé à être exécuté. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| StopTime |
Retourne le moment où le conteneur a terminé son exécution. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| SuppressConfigurationWarnings |
Obtient ou définit une valeur qui indique si les avertissements générés par les configurations sont supprimés. |
| SuspendRequired |
Obtient ou définit un booléen qui indique si les tâches doivent être suspendues lorsqu’elles rencontrent un point d’arrêt. Cette valeur est définie par le moteur d’exécution pour les tâches et conteneurs lorsqu’un point d’arrêt est rencontré. (Hérité de DtsContainer) |
| TransactionOption |
Obtient ou définit une DTSTransactionOption valeur d’énumération qui indique si le conteneur participe aux transactions. (Hérité de DtsContainer) |
| UpdateObjects |
membre déprécié ; voir Remarques. Obtient ou définit une valeur qui indique si les objets extensibles peuvent être mis à jour au moment du chargement du paquet si une version mise à jour est trouvée. |
| VariableDispenser |
Retourne un VariableDispenser objet afin que les variables associées au conteneur puissent être verrouillées. (Hérité de DtsContainer) |
| Variables |
Retourne une collection contenant les variables associées à ce conteneur. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
| VersionBuild |
Il obtient la version build du package. |
| VersionComments |
Il reçoit les commentaires de version associés au paquet. |
| VersionGUID |
Obtient la version GUID générée lors de la création du paquet. Ce champ est en lecture seule. |
| VersionMajor |
Il obtient la version principale du pack. |
| VersionMinor |
Il obtient la version mineure du package. |
| Warnings |
Ça met la collection d’avertissements sur le paquet. Ce champ est en lecture seule. |
Méthodes
| Nom | Description |
|---|---|
| AcceptBreakpointManager(BreakpointManager) |
Cette méthode est appelée par le moteur d’exécution lorsqu’une tâche ou un conteneur est créée, et lui transmet un BreakpointManager gestionnaire pour permettre à la tâche de créer, supprimer et vérifier l’état des points d’arrêt. Cette méthode est appelée par l’exécution et n’est pas utilisée dans le code. (Hérité de DtsContainer) |
| AddDataTapPoint(String, String, Int32, String) |
Ajoutez un point de prise de données sur un flux de données donné et un chemin de flux de données donné. |
| CheckSignature() |
Vérifie l’état de la signature numérique du colis. |
| ComputeExpressions(Boolean) |
Calculer les expressions de l’objet package. |
| Dispose() |
Effectue des tâches définies par l’application associées à la libération, à la libération ou à la réinitialisation des ressources non managées. (Hérité de DtsContainer) |
| Equals(Object) |
Détermine si deux instances d’objet sont égales. (Hérité de DtsObject) |
| Execute() |
Retourne une DTSExecResult énumération contenant des informations sur le succès ou l’échec de l’exécution du paquet. |
| Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) |
Exécute l’application, le conteneur ou le package dans le cadre d’un flux de travail de paquet. (Hérité de DtsContainer) |
| ExportConfigurationFile(String) |
Crée un fichier XML contenant toutes les variables déployables du paquet. |
| FindReferencedObjects(Object) |
Retourne une énumération d’objets de référence. |
| GetBreakpointTargets(IDTSBreakpointSite, Boolean) |
Retourne une BreakpointTargets collection. Selon le paramètre de réglage |
| GetExecutionPath() |
Retourne le chemin d’exécution du package courant. |
| GetExpression(String) |
Retourne une valeur contenant l’expression pour la propriété spécifiée. Nul signifie qu’aucune expression n’est assignée. |
| GetHashCode() |
Retourne le code de hachage pour cette instance. (Hérité de DtsObject) |
| GetObjectFromPackagePath(String, DtsProperty) |
Retourne une propriété de paquet et l’objet du chemin de paquet spécifié. |
| GetPackagePath() |
Retourne une valeur contenant le chemin relatif vers l’emplacement du paquet. |
| ImportConfigurationFile(String) |
Charge un fichier de configuration associé au package. |
| LoadFromXML(String, IDTSEvents) |
Charge un package et tous ses objets qui ont été sauvegardés en mémoire au format XML. Pour charger un package enregistré sur le disque dur, utilisez la LoadPackage(String, IDTSEvents) méthode. |
| LoadFromXML(XmlNode, IDTSEvents) |
Cette méthode n’est pas appelable par votre code d’application. Pour charger un colis enregistré en tant que .xml, utilisez la LoadPackage(String, IDTSEvents) méthode. (Hérité de DtsContainer) |
| LoadUserCertificateByHash(Byte[]) |
Charge le certificat du colis selon le hachage du certificat. |
| LoadUserCertificateByName(String) |
Charge le certificat du colis selon le nom du certificat. |
| ProcessConfiguration(String, Object) |
Spécifie les informations de configuration pour un package et ses objets. |
| RegenerateID() |
Crée un nouvel identificateur global unique (GUID) pour le package et met à jour la propriété de l'ID du package. |
| ResumeExecution() |
Reprend l’exécution de la tâche après une pause. La tâche ou le conteneur est repris par le moteur d’exécution. (Hérité de DtsContainer) |
| SaveToXML(String, IDTSEvents) |
Sauvegarde le paquet en mémoire au format XML. Pour sauvegarder un paquet .xml sur le disque dur, utilisez la SaveToXml(String, Package, IDTSEvents) méthode. |
| SaveToXML(XmlDocument, XmlNode, IDTSEvents) |
Cette méthode n’est pas appelable par votre code d’application. Pour enregistrer un paquet en tant que .xml, utilisez la SaveToXml(String, Package, IDTSEvents) méthode. (Hérité de DtsContainer) |
| SetExpression(String, String) |
Attribue l’expression spécifiée à la propriété. Spécifier null pour retirer une expression existante de la propriété. |
| SetWrappedExecutable(IDTSExecutable100) |
Retourne l’objet exécutable enroulé. (Hérité de EventsProvider) |
| SuspendExecution() |
Appelée lorsque l’exécutable doit être suspendue. Cette méthode est appelée par le moteur d’exécution. (Hérité de DtsContainer) |
| Validate(Connections, Variables, IDTSEvents, IDTSLogging) |
Permet au conteneur de déterminer s’il contient des paramètres invalides qui l’empêcheront d’exécuter correctement. (Hérité de DtsContainer) |
Événements
| Nom | Description |
|---|---|
| Disposed |
Ajoute un gestionnaire d’événements pour écouter l’événement Disposed sur le composant. (Hérité de DtsContainer) |