Classe ScriptOption

L'objet ScriptOption représente les options de script SQL Server qui peuvent être incluses dans les options de script définies à l'aide de l'objet ScriptingOptions.

Hiérarchie d'héritage

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo..::..ScriptOption

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class ScriptOption
'Utilisation
Dim instance As ScriptOption
public sealed class ScriptOption
public ref class ScriptOption sealed
[<SealedAttribute>]
type ScriptOption =  class end
public final class ScriptOption

Le type ScriptOption expose les membres suivants.

Propriétés

  Nom Description
Propriété publiqueMembre statique AgentAlertJob Obtient un objet qui spécifie s'il faut inclure les alertes et les travaux de l'Agent SQL Server dans le script. 
Propriété publiqueMembre statique AgentJobId Obtient un objet qui spécifie s'il faut inclure les alertes et les travaux de l'Agent SQL Server dans le script. 
Propriété publiqueMembre statique AgentNotify Obtient un objet qui spécifie s'il faut inclure des notifications pour toutes alertes de l'Agent SQL Server qui sont dans le script. 
Propriété publiqueMembre statique AllowSystemObjects Obtient un objet qui spécifie si les objets système peuvent faire l'objet d'un script.
Propriété publiqueMembre statique AnsiFile Obtient un objet qui spécifie si le script utilise des caractères multioctets et requiert que la page de codes 1252 évalue la signification des caractères.
Propriété publiqueMembre statique AnsiPadding Obtient un objet qui spécifie si le script généré contient les instructions Transact-SQL SET ANSI-PADDING ON et SET ANSI-PADDING OFF avant et après l'instruction CREATE TABLE, respectivement.
Propriété publiqueMembre statique AppendToFile Obtient un objet qui spécifie si le script est ajouté à la fin du fichier de sortie ou le remplace.
Propriété publiqueMembre statique Bindings Obtient un objet qui spécifie si les instructions de liaison sp_binddefault et sp_bindrule sont incluses dans le script généré. Cette propriété s'applique uniquement lors de la génération d'un script pour une table Microsoft SQL Server.
Propriété publiqueMembre statique ChangeTracking Obtient la valeur de la propriété ChangeTracking.
Propriété publiqueMembre statique ClusteredIndexes Obtient un objet qui spécifie si les instructions qui définissent des index cluster sont incluses dans le script généré.
Propriété publiqueMembre statique ContinueScriptingOnError Obtient une valeur d'objet qui spécifie si l'opération de script continue en cas d'erreur.
Propriété publiqueMembre statique ConvertUserDefinedDataTypesToBaseType Obtient une valeur d'objet qui spécifie si les types de données définis par l'utilisateur sont convertis en types de données de base SQL Server plus appropriés dans le script généré. 
Propriété publiqueMembre statique DdlBodyOnly Obtient une valeur d'objet qui spécifie s'il faut enregistrer dans un script uniquement la définition de texte pour les objets de langage de définition de données (DDL) qui ont un corps de texte, tels que les procédures stockées et les déclencheurs.
Propriété publiqueMembre statique DdlHeaderOnly Obtient une valeur d'objet qui spécifie s'il faut enregistrer dans un script uniquement les informations d'en-tête pour les objets de langage de définition de données (DDL) qui ont un corps de texte, tels que les procédures stockées et les déclencheurs.
Propriété publiqueMembre statique Default Obtient une valeur d'objet qui spécifie si la création de l'objet référencé est incluse dans le script généré.
Propriété publiqueMembre statique DriAll Obtient une valeur d'objet qui spécifie si les objets DRI sont inclus dans le script généré.
Propriété publiqueMembre statique DriAllConstraints Obtient une valeur d'objet qui spécifie si toutes les contraintes DRI sont incluses dans le script généré.
Propriété publiqueMembre statique DriAllKeys Obtient une valeur d'objet qui spécifie si toutes les clés DRI (DriForeignKeys, DriPrimaryKey, DriUniqueKeys) sont incluses dans le script généré.
Propriété publiqueMembre statique DriChecks Obtient une valeur d'objet qui spécifie si les relations de dépendance spécifiques aux colonnes définies dans les contraintes de validation avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriClustered Obtient une valeur d'objet qui spécifie si les relations de dépendance définies dans les index cluster avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriDefaults Obtient une valeur d'objet qui spécifie si les relations de dépendance définies dans les valeurs par défaut avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriForeignKeys Obtient une valeur d'objet qui spécifie si les relations de dépendance définies dans les clés étrangères avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriIncludeSystemNames Obtient une valeur d'objet qui spécifie si les noms de contrainte générés par le système et utilisés pour appliquer l'intégrité référentielle déclarative sont inclus dans le script.
Propriété publiqueMembre statique DriIndexes Obtient une valeur d'objet qui spécifie si les contraintes PRIMARY KEY qui utilisent un index unique pour implémenter l'intégrité référentielle déclarative sont incluses dans le script généré.
Propriété publiqueMembre statique DriNonClustered Obtient une valeur d'objet qui spécifie si les relations de dépendance définies dans les index non cluster avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriPrimaryKey Obtient une valeur d'objet qui spécifie si les relations de dépendance définies dans les clés primaires avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriUniqueKeys Obtient une valeur d'objet qui spécifie si les relations de dépendance définies dans les clés uniques avec intégrité référentielle déclarative sont incluses dans le script.
Propriété publiqueMembre statique DriWithNoCheck Obtient une valeur d'objet qui spécifie si l'instruction NO CHECK est incluse dans le script.
Propriété publiqueMembre statique EnforceScriptingOptions Obtient une valeur d'objet qui spécifie si toutes les options de script sont appliquées pour les objets basés sur le texte, tels que SchemaQualify.
Propriété publiqueMembre statique ExtendedProperties Obtient une valeur d'objet qui spécifie si les propriétés étendues de l'objet sont incluses dans le script généré.
Propriété publiqueMembre statique FullTextCatalogs Obtient une valeur d'objet qui spécifie si les catalogues de texte intégral sont inclus dans le script généré.
Propriété publiqueMembre statique FullTextIndexes Obtient une valeur d'objet qui spécifie si les index de recherche en texte intégral sont inclus dans le script généré.
Propriété publiqueMembre statique FullTextStopLists Obtient une valeur d'objet qui spécifie si les listes de mots vides de texte intégral sont incluses dans le script généré.
Propriété publiqueMembre statique IncludeDatabaseContext Obtient une valeur d'objet qui spécifie si le contenu de la base de données est inclus dans le script généré.
Propriété publiqueMembre statique IncludeDatabaseRoleMemberships Obtient la valeur de la propriété IncludeDatabaseRoleMemberships.
Propriété publiqueMembre statique IncludeFullTextCatalogRootPath Obtient la valeur de la propriété IncludeFullTextCatalogRootPath.
Propriété publiqueMembre statique IncludeHeaders Obtient un objet qui spécifie si le script généré est préfixé avec un en-tête qui contient des informations telles que la date et l'heure de génération.
Propriété publiqueMembre statique IncludeIfNotExists Obtient un objet qui spécifie s'il faut vérifier l'existence d'un objet avant de l'inclure dans le script.
Propriété publiqueMembre statique Indexes Obtient un objet qui spécifie si les index sont inclus dans le script généré.
Propriété publiqueMembre statique LoginSid Obtient ou définit la valeur de la propriété booléenne qui spécifie si les identificateurs de sécurité sont inclus pour toutes les connexions qui font l'objet d'un script dans le script généré.
Propriété publiqueMembre statique NoAssemblies Obtient un objet qui spécifie si les assemblys sont exclus du script généré.
Propriété publiqueMembre statique NoCollation Obtient une valeur d'objet qui spécifie s'il faut inclure la collection dans le script généré si le serveur exécute SQL Server 7.0 ou une version ultérieure.
Propriété publiqueMembre statique NoCommandTerminator Obtient une valeur d'objet qui spécifie si les instructions Transact-SQL individuelles sont délimitées dans le script généré.
Propriété publiqueMembre statique NoExecuteAs Obtient une valeur d'objet qui spécifie si les options EXECUTE AS des procédures stockées et des fonctions définies par l'utilisateur sont incluses dans le script.
Propriété publiqueMembre statique NoFileGroup Obtient une valeur d'objet qui spécifie s'il faut inclure la clause « ON <filegroup> » dans le script généré.
Propriété publiqueMembre statique NoFileStream Obtient un objet qui spécifie s'il faut inclure la clause FILESTREAM_ON lorsque vous créez des colonnes VarBinaryMax dans le script généré.
Propriété publiqueMembre statique NoFileStreamColumn Obtient un objet qui spécifie s'il faut inclure la clause FILESTREAM_ON lorsque vous créez des colonnes VarBinaryMax dans le script généré.
Propriété publiqueMembre statique NoIdentities Obtient une valeur d'objet qui spécifie si les définitions de la valeur initiale et de la valeur d'incrément de la propriété d'identité sont incluses dans le script généré.
Propriété publiqueMembre statique NoIndexPartitioningSchemes Obtient une valeur d'objet qui spécifie si les schémas de partition des index sont inclus dans le script généré.
Propriété publiqueMembre statique NoMailProfileAccounts Obtient une valeur d'objet qui spécifie si les comptes de messagerie référencés par les profils de messagerie sont inclus dans le script généré.
Propriété publiqueMembre statique NoMailProfilePrincipals Obtient une valeur d'objet qui spécifie si les principaux référencés par les profils de messagerie sont exclus du script généré.
Propriété publiqueMembre statique NonClusteredIndexes Obtient une valeur d'objet qui spécifie si les index non cluster sont inclus dans le script généré.
Propriété publiqueMembre statique NoTablePartitioningSchemes Obtient une valeur d'objet qui spécifie si les schémas de partition des tables sont inclus dans le script généré.
Propriété publiqueMembre statique NoVardecimal Obtient la valeur de la propriété NoVardecimal.
Propriété publiqueMembre statique NoViewColumns Obtient une valeur d'objet qui spécifie s'il faut inclure les colonnes spécifiées pour une vue.
Propriété publiqueMembre statique NoXmlNamespaces Obtient une valeur d'objet qui spécifie si les espaces de noms XML sont inclus dans le script généré.
Propriété publiqueMembre statique OptimizerData Obtient une valeur d'objet qui spécifie si les données de l'optimiseur de script pour les objets référencés sont incluses dans le script généré.
Propriété publiqueMembre statique Permissions Obtient une valeur d'objet qui spécifie si toutes les autorisations sont incluses dans le script généré.
Propriété publiqueMembre statique PrimaryObject Obtient une valeur d'objet qui spécifie si la création de l'objet référencé est incluse dans le script généré.
Propriété publiqueMembre statique SchemaQualify Obtient une valeur d'objet qui spécifie si le script contient un objet sans schéma.
Propriété publiqueMembre statique SchemaQualifyForeignKeysReferences Obtient une valeur d'objet qui spécifie si les tables sans schéma référencées par une clé étrangère sont incluses dans le script généré.
Propriété publiqueMembre statique ScriptBatchTerminator Obtient la valeur de la propriété ScriptBatchTerminator.
Propriété publiqueMembre statique ScriptData Obtient la valeur de la propriété ScriptData.
Propriété publiqueMembre statique ScriptDataCompression Obtient une valeur d'objet qui spécifie si la création de l'objet référencé est incluse dans le script généré.
Propriété publiqueMembre statique ScriptOwner Obtient une valeur d'objet qui spécifie si la création de l'objet référencé est incluse dans le script généré.
Propriété publiqueMembre statique ScriptSchema Obtient la valeur de la propriété ScriptSchema.
Propriété publiqueMembre statique Statistics Obtient une valeur d'objet qui spécifie si les statistiques sont générées pour toutes les tables ou les vues incluses dans le script généré.
Propriété publiqueMembre statique TimestampToBinary Obtient une valeur d'objet qui spécifie s'il faut convertir les types de données timestamp en types de données binaires (8) pour le script de création d'une table ou d'un type de données défini par l'utilisateur.
Propriété publiqueMembre statique ToFileOnly Obtient une valeur d'objet qui spécifie s'il faut retourner uniquement un fichier ou s'il faut également générer une sortie de chaîne.
Propriété publiqueMembre statique Triggers Obtient une valeur d'objet qui spécifie s'il faut inclure la définition des déclencheurs dans le script généré.
Propriété publiqueMembre statique WithDependencies Obtient une valeur d'objet qui spécifie s'il faut inclure tous les objets dépendants dans le script généré.
Propriété publiqueMembre statique XmlIndexes Obtient une valeur d'objet qui spécifie si les index XML sont inclus dans le script généré.

Haut de la page

Méthodes

  Nom Description
Méthode publiqueMembre statique Add Ajoute deux objets ScriptOption pour créer un objet ScriptOptions.
Méthode publiqueMembre statique BitwiseOr Combine deux objets ScriptingOptions à l'aide d'une opération OR au niveau du bit.
Méthode publique Equals Retourne une valeur booléenne qui spécifie si deux ScriptOptions sont égaux. (remplace Object. . :: . .Equals(Object).)
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetHashCode Retourne le code de hachage pour cet objet. (remplace Object. . :: . .GetHashCode() () () ().)
Méthode publique GetType (hérité de Object.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (remplace Object. . :: . .ToString() () () ().)

Haut de la page

Opérateurs

  Nom Description
Opérateur publicMembre statique Addition Crée un jeu d'options de script en effectuant une opération d'ajout sur deux objets ScriptOption.
Opérateur publicMembre statique BitwiseOr Crée un jeu d'options de script en effectuant une opération OR au niveau du bit sur deux objets ScriptOption.
Opérateur publicMembre statique Implicit Widening Implicit Implicit Implicit(ScriptOption to ScriptingOptions) Convertit implicitement l'objet ScriptOption spécifié en objet ScriptingOptions.

Haut de la page

Notes

The ScriptOption object contains a property for each type of SQL Server item that can be scripted. The actual set of items to be scripted is specified using the ScriptingOptions object.

Warning: Some script options cause the Transfer object to generate script that does not execute on the target server.

Thread Safety

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Exemples

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")
'Define a Scripter object and set the required scripting options.
Dim scrp As Scripter
scrp = New Scripter(srv)
scrp.Options.ScriptDrops = False
scrp.Options.WithDependencies = True
'Iterate through the tables in database and script each one. Display the script.
'Note that the StringCollection type needs the System.Collections.Specialized namespace to be included.
Dim tb As Table
Dim smoObjects(1) As Urn
For Each tb In db.Tables
    smoObjects = New Urn(0) {}
    smoObjects(0) = tb.Urn
    If tb.IsSystemObject = False Then
        Dim sc As StringCollection
        sc = scrp.Script(smoObjects)
        Dim st As String
        For Each st In sc
            Console.WriteLine(st)
        Next
    End If
Next

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.