SchemaCompareScriptService, classe

Article
08/10/2011

Fournit des méthodes pour analyser et afficher des scripts d'objet pour une base de données cible dans la fenêtre définition d'objet et la fenêtre Outil de script de mise à jourVisual Studio Premium etVisual Studio Ultimate. En outre, ce service peut modifier la structure de la base de données cible pour correspondre au schéma de la base de données source en créant et en exécutant l'A.DeploymentPlan

Hiérarchie d'héritage

System.Object
Microsoft.Data.Schema.Tools.Compare.Schema.SchemaCompareScriptService

Espace de noms : Microsoft.Data.Schema.Tools.Compare.Schema
Assembly : Microsoft.Data.Schema.Tools (dans Microsoft.Data.Schema.Tools.dll)

Syntaxe

'Déclaration
<DatabaseSchemaProviderCompatibilityAttribute(GetType(DatabaseSchemaProvider))> _
Public Class SchemaCompareScriptService _
    Implements IExtensionInformation, IExtension

[DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))]
public class SchemaCompareScriptService : IExtensionInformation, 
    IExtension

[DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))]
public ref class SchemaCompareScriptService : IExtensionInformation, 
    IExtension

[<DatabaseSchemaProviderCompatibilityAttribute(typeof(DatabaseSchemaProvider))>]
type SchemaCompareScriptService =  
    class
        interface IExtensionInformation
        interface IExtension
    end

public class SchemaCompareScriptService implements IExtensionInformation, IExtension

Le type SchemaCompareScriptService expose les membres suivants.

Constructeurs

	Nom	Description
	SchemaCompareScriptService	Initialise une nouvelle instance de la classe SchemaCompareScriptService.

Début

Propriétés

	Nom	Description
	Canceled	Obtient ou définit une valeur qui indique si les processus du service de script ont été annulés.
	DatabaseSchemaProvider	Obtient le fournisseur de schémas de base de données actuel.
	ExtensionHandle	Obtient le handle d'extension du service de script.
	ModelComparer	Retourne le comparateur de modèles actuel.
	ScriptDomGenerator	En cas de substitution dans une classe dérivée, obtient le générateur de modèle de document de script pour le fournisseur de schémas de base de données actuel.
	ScriptGenerator	En cas de substitution dans une classe dérivée, obtient le générateur de script pour le fournisseur de schémas de base de données actuel.
	UpdateScriptFileExtension
	UpdateScriptFileFilterDescription

Début

Méthodes

	Nom	Description
	Cancel	Affecte à la propriété Canceled la valeur true, ce qui signale à tous les processus enclenchés qu'ils ont été annulés.
	CreateDeploymentController	Retourne un objet ISchemaDeploymentController.
	CreateExcludedElement	Retourne un élément exclu du plan par l'utilisateur dans la fenêtre Comparaison de schémas de Visual Studio Premium et Visual Studio Ultimate.
	CreateSchemaDeployment	En cas de substitution dans une classe dérivée, retourne un objet SchemaDeployment.
	Equals	Détermine si l'Object spécifié est égal à l'Object en cours. (Hérité de Object.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GenerateObjectDefinition	Retourne un objet de fragment de script devant être affiché dans la fenêtre Définition d'objet de Visual Studio Premium et Visual Studio Ultimate qui créerait ou supprimerait l'élément donné de la base de données.
	GenerateObjectScript	Retourne un script à l'aide de l'objet de fragment de script fourni.
	GenerateUpdatePlan	Génère le script de mise à jour complet en cas d'appel par un DatabaseSchemaProvider.
	GetContainingElement	Retourne l'élément qui contient le script pour l'élément fourni.
	GetDependencyInformation
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetSchemaModelFromConnectionBasedProvider
	GetSchemaModelFromFileBasedProvider	Retourne le fournisseur de modèles basé sur fichier qui doit être utilisé par la fenêtre Comparaison de schémas de Visual Studio Premium et Visual Studio Ultimate.
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	GetUpdateTargetConfirmationMessage	Retourne un message de confirmation cible pour la fenêtre Comparaison de schémas de Visual Studio Premium et Visual Studio Ultimate.
	Initialize	Appelée par la fenêtre Définition d'objet pour initialiser des paramètres pour l'objet SchemaCompareScriptService.
	MemberwiseClone	Crée une copie superficielle de l'objet Object actif. (Hérité de Object.)
	OnAfterCompare
	OnAfterGeneratePlan	Appelée par la méthode GenerateUpdatePlan pour fournir à DatabaseSchemaProvider l'accès au plan de déploiement et au contrôleur de déploiement après que le plan a été généré.
	OnAfterUpdateTargetDatabase	Appelée par la méthode UpdateTargetDatabase pour fournir à DatabaseSchemaProvider l'accès aux valeurs de paramètres après que la base de données cible a été mise à jour.
	OnBeforeCompare
	OnBeforeGeneratePlan	Appelée par la méthode GenerateUpdatePlan pour fournir à DatabaseSchemaProvider l'accès au contrôleur de déploiement avant que le plan de mise à jour ait été généré.
	OnBeforeUpdateTargetDatabase	Appelée par la méthode UpdateTargetDatabase pour fournir à DatabaseSchemaProvider l'accès aux valeurs de paramètres avant que la base de données cible ait été mise à jour.
	OnFinishGeneratePlan	Appelée par la méthode GenerateUpdatePlan pour fournir à DatabaseSchemaProvider l'accès au contrôleur de déploiement après que le plan de mise à jour a été généré et que les erreurs ont été recueillies.
	OnStartGeneratePlan	Appelée par la méthode GenerateUpdatePlan pour fournir à DatabaseSchemaProvider l'accès aux valeurs de paramètre initiales fournies avant la génération du plan de mise à jour.
	RaiseSyncCanceledEvent	Par défaut, appelée à partir de la méthode UpdateTargetDatabase.
	RaiseSyncCompletedEvent	Déclenche SyncCompletedEvent.
	RaiseSyncProgressStatusEvent	Déclenche SyncCompletedEvent à l'aide du message et du nombre fournis.
	ResetCancel	Réinitialise l'indicateur d'annulation interne à la valeur false.
	SetExtensionHandle	Définit le handle d'extension à la valeur spécifiée.
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
	UpdateTargetDatabase	Appelée par la fenêtre Outil de mise à jour de script de Visual Studio Premium et Visual Studio Ultimate pour mettre à jour la base de données cible à l'aide du plan de déploiement fourni et des autres valeurs de paramètres.
	UpdateTargetProject	En cas de substitution dans une classe dérivée, met à jour le projet cible donné à l'aide des autres valeurs de paramètres.
	UseMultiThreadingForModelPopulation

Début

Événements

	Nom	Description
	SyncCanceledEvent	Se produit lorsque la méthode Cancel ou RaiseSyncCanceledEvent est appelée.
	SyncCompletedEvent	Se produit lorsque la méthode RaiseSyncCompletedEvent est appelée.
	SyncProgressStatusEvent	Se produit lorsque la méthode RaiseSyncProgressStatusEvent est appelée.

Début

Notes

Cette classe est l'un des points d'extension prédéfinis pour la fenêtre Comparaison de schémas dans Visual Studio Premium et Visual Studio Ultimate. L'autre point d'extension prédéfini est la classe SchemaCompareSettingsService.

Pour prendre en charge un DatabaseSchemaProvider personnalisé, vous aurez probablement besoin d'une version personnalisée correspondante de cette classe SchemaCompareScriptService. Cela est particulièrement nécessaire pour substituer la méthode UpdateTargetDatabase et la méthode UpdateTargetProject, si vous devez mettre à jour des projets ainsi que des bases de données.

Remarques à l'attention des héritiers

D'autres classes que vous devez étendre pour une version dérivée de cette classe pour prendre en charge un DatabaseSchemaProvider spécifique :

Vous devez également implémenter l'interface ISchemaDeploymentController.

Vous devrez peut-être étendre d'autres classes et implémenter d'autres interfaces pour votre implémentation spécifique.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.