Freigeben über


ScriptingOptions-Klasse

The ScriptingOptions object provides programmatic options to the options that can be set for scripting operations.

Vererbungshierarchie

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

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class ScriptingOptions
'Usage
Dim instance As ScriptingOptions
public sealed class ScriptingOptions
public ref class ScriptingOptions sealed
[<SealedAttribute>]
type ScriptingOptions =  class end
public final class ScriptingOptions

Der ScriptingOptions-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode ScriptingOptions() () () () Initializes a new instance of the ScriptingOptions class.
Öffentliche Methode ScriptingOptions(ScriptingOptions) Initializes a new instance of the ScriptingOptions class based on the specified scripting options.
Öffentliche Methode ScriptingOptions(ScriptOption) Initializes a new instance of the ScriptingOptions class based on the specified ScriptOption object, based on the specified script option.

Zum Anfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft AgentAlertJob Gets or sets the Boolean property that specifies whether to include SQL Server Agent job name for alert objects in the script.
Öffentliche Eigenschaft AgentJobId Gets or sets the Boolean property that specifies whether to include SQL Server Agent job ID values for alert objects in the script.
Öffentliche Eigenschaft AgentNotify Gets or sets the Boolean property that specifies whether to include notifications for any SQL Server Agent alerts that are in the script.
Öffentliche Eigenschaft AllowSystemObjects Gets or sets the Boolean property that specifies whether system objects can be scripted.
Öffentliche Eigenschaft AnsiFile Gets or sets the Boolean property that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters' meaning.
Öffentliche Eigenschaft AnsiPadding Gets or sets a Boolean property that specifies whether the generated script contains the Transact-SQL statements SET ANSI-PADDING ON and SET ANSI-PADDING OFF before and after the CREATE TABLE statement, respectively.
Öffentliche Eigenschaft AppendToFile Gets or sets a Boolean property value that specifies whether the script is appended to the end of the output file or overwrites it.
Öffentliche Eigenschaft BatchSize Gets or sets the number of statements after which to script batch terminator.
Öffentliche Eigenschaft Bindings Gets or sets a Boolean property value that specifies whether the binding statements sp_binddefault and sp_bindrule are included in the generated script. This property applies only when scripting a SQL Server table.
Öffentliche Eigenschaft ChangeTracking Gets or sets the ChangeTracking property value.
Öffentliche Eigenschaft ClusteredIndexes Gets or sets a Boolean property value that specifies whether statements that define clustered indexes are included in the generated script.
Öffentliche Eigenschaft ContinueScriptingOnError Gets or sets the Boolean property value that specifies whether the scripting operation continues after an error is encountered.
Öffentliche Eigenschaft ConvertUserDefinedDataTypesToBaseType Gets or sets the Boolean property value that specifies whether user-defined data types are converted to the most appropriate SQL Server base data types in the generated script.
Öffentliche Eigenschaft DdlBodyOnly Gets or sets the Boolean property value that specifies whether to script only the text definition for data definition language (DDL) objects that have a text body, such as stored procedures and triggers.
Öffentliche Eigenschaft DdlHeaderOnly Gets or sets the Boolean property value that specifies whether to script only the header information for data definition language (DDL) objects that have a text body, such as stored procedures and triggers.
Öffentliche Eigenschaft Default Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.
Öffentliche Eigenschaft DriAll Gets or sets the Boolean property value that specifies whether all DRI objects are included in the generated script.
Öffentliche Eigenschaft DriAllConstraints Gets or sets the Boolean property value that specifies whether all declarative referential integrity constraints are included in the generated script.
Öffentliche Eigenschaft DriAllKeys Gets or sets the Boolean property value that specifies whether the dependency relationships defined by all declarative referential integrity keys are included in the generated script.
Öffentliche Eigenschaft DriChecks Gets or sets the Boolean property value that specifies whether column specific dependency relationships as defined in check constraints with enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriClustered Gets or sets the Boolean property value that specifies whether dependency relationships defined in clustered indexes with enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriDefaults Gets or sets the Boolean property value that specifies whether dependency relationships defined in defaults with enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriForeignKeys Gets or sets the Boolean property value that specifies whether dependency relationships defined in foreign keys with enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriIncludeSystemNames Gets or sets the Boolean property value that specifies whether the system-generated constraint names that are used to enforce declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriIndexes Gets or sets the Boolean property value that specifies whether PRIMARY KEY constraints that use a unique index to implement the declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriNonClustered Gets or sets the Boolean property value that specifies whether dependency relationships that are defined in non-clustered indexes that have enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriPrimaryKey Gets or sets the Boolean property value that specifies whether dependency relationships that are defined in primary keys which have enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriUniqueKeys Gets or sets the Boolean property value that specifies whether dependency relationships that are defined in unique keys which have enforced declarative referential integrity are included in the script.
Öffentliche Eigenschaft DriWithNoCheck Gets or sets the Boolean property value that specifies whether the no check statement is included in the script.
Öffentliche Eigenschaft Encoding Gets or sets the encoding for the scripting options.
Öffentliche Eigenschaft EnforceScriptingOptions Gets or sets the Boolean property value that specifies whether the application of all scripting options is enforced for text-based objects, such as SchemaQualify.
Öffentliche Eigenschaft ExtendedProperties Gets or sets the Boolean property value that specifies whether extended object properties are included in the generated script.
Öffentliche Eigenschaft FileName Gets or sets the name of the file to which the generated script is output.
Öffentliche Eigenschaft FullTextCatalogs Gets or sets the Boolean property value that specifies whether full-text catalogs are included in the generated script.
Öffentliche Eigenschaft FullTextIndexes Gets or sets the Boolean property value that specifies whether full-text indexes are included in the generated script.
Öffentliche Eigenschaft FullTextStopLists Gets or sets the Boolean property value that specifies whether full-text stop lists are included in the generated script.
Öffentliche Eigenschaft IncludeDatabaseContext Gets or sets the Boolean property value that specifies whether database context is included in the generated script.
Öffentliche Eigenschaft IncludeDatabaseRoleMemberships Gets or sets the IncludeDatabaseRoleMemberships property value.
Öffentliche Eigenschaft IncludeFullTextCatalogRootPath Gets or sets the IncludeFullTextCatalogRootPath property value.
Öffentliche Eigenschaft IncludeHeaders Gets or sets a Boolean property value that specifies whether the generated script is prefixed with a header that contains information which includes the date and time of generation.
Öffentliche Eigenschaft IncludeIfNotExists Gets or sets a Boolean property value that specifies whether to check the existence of an object before including it in the script.
Öffentliche Eigenschaft Indexes Gets or sets the Boolean property value that specifies whether indexes are included in the generated script.
Öffentliche Eigenschaft LoginSid Gets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.
Öffentliche Eigenschaft NoAssemblies Gets or sets the Boolean property value that specifies whether assemblies are included in the generated script.
Öffentliche Eigenschaft NoCollation Gets or sets the Boolean property value that specifies whether to include the collation clause in the generated script.
Öffentliche Eigenschaft NoCommandTerminator Gets or sets the Boolean property value that specifies whether individual Transact-SQL statements are delimited in the generated script.
Öffentliche Eigenschaft NoExecuteAs Gets or sets the Boolean property value that specifies whether the EXECUTE AS options for stored procedures and user-defined functions are included in the script.
Öffentliche Eigenschaft NoFileGroup Gets or sets the Boolean property value that specifies whether to include the 'ON <filegroup>' clause in the generated script.
Öffentliche Eigenschaft NoFileStream Gets or sets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
Öffentliche Eigenschaft NoFileStreamColumn Gets or sets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
Öffentliche Eigenschaft NoIdentities Gets or sets the Boolean property value that specifies whether definitions of identity property seed and increment are included in the generated script.
Öffentliche Eigenschaft NoIndexPartitioningSchemes Gets or sets the Boolean property value that specifies whether partition schemes for indexes are included in the generated script.
Öffentliche Eigenschaft NoMailProfileAccounts Gets or sets the Boolean property value that specifies whether mail accounts that are referenced by mail profiles are included in the generated script.
Öffentliche Eigenschaft NoMailProfilePrincipals Gets or sets the Boolean property value that specifies whether principals that are referenced by mail profiles are included in the generated script.
Öffentliche Eigenschaft NonClusteredIndexes Gets or sets the Boolean property value that specifies whether non-clustered indexes are included in the generated script.
Öffentliche Eigenschaft NoTablePartitioningSchemes Gets or sets the Boolean property value that specifies whether partition schemes for tables are included in the generated script.
Öffentliche Eigenschaft NoVardecimal Gets or sets an object that specifies whether to include the N clause when you create vardecimal columns in the generated script.
Öffentliche Eigenschaft NoViewColumns Gets or sets the Boolean property value that specifies whether to include the specified columns for a view.
Öffentliche Eigenschaft NoXmlNamespaces Gets or sets the Boolean property value that specifies whether XML namespaces are included in the generated script.
Öffentliche Eigenschaft OptimizerData Gets or sets the Boolean property value that specifies whether script optimizer data for the referenced objects are included in the generated script.
Öffentliche Eigenschaft Permissions Gets or sets the Boolean property value that specifies whether to include all permissions in the generated script.
Öffentliche Eigenschaft PrimaryObject Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.
Öffentliche Eigenschaft SchemaQualify Gets or sets the Boolean property value that specifies whether the schemas associated with objects are included in the generated script.
Öffentliche Eigenschaft SchemaQualifyForeignKeysReferences Gets or sets the Boolean property value that specifies whether schema-qualified table references for foreign key constraints are included in the generated script.
Öffentliche Eigenschaft ScriptBatchTerminator Gets or sets the ScriptBatchTerminator property value.
Öffentliche Eigenschaft ScriptData Gets or sets the ScriptData property value.
Öffentliche Eigenschaft ScriptDataCompression Gets or sets the Boolean property value that specifies whether to include data compression information in the generated script.
Öffentliche Eigenschaft ScriptDrops Gets or sets the Boolean property value that specifies whether the script operation generates a Transact-SQL script to remove the referenced component.
Öffentliche Eigenschaft ScriptOwner Gets or sets the Boolean property value that specifies whether the script owner is included in the generated script.
Öffentliche Eigenschaft ScriptSchema Gets or set the ScriptSchema property value.
Öffentliche Eigenschaft Statistics Gets or sets the Boolean property value that specifies whether to include statistics for any table or view that is included in the generated script.
Öffentliche Eigenschaft TargetDatabaseEngineType Gets or sets the DatabaseEngineType property value.
Öffentliche Eigenschaft TargetServerVersion Gets or sets the version of the instance of SQL Server for which the generated script is intended.
Öffentliche Eigenschaft TimestampToBinary Gets or sets the Boolean property value that specifies whether to convert timestamp data types to binary(8) data types when scripting the creation of a table or user-defined data type.
Öffentliche Eigenschaft ToFileOnly Gets or sets the Boolean property value that specifies whether to output to file only or to also generate string output.
Öffentliche Eigenschaft Triggers Gets or sets the Boolean property value that specifies whether to include the definition for triggers in the generated script.
Öffentliche Eigenschaft WithDependencies Gets or sets the Boolean property value that specifies whether to include all dependent objects in the generated script.
Öffentliche Eigenschaft XmlIndexes Gets or sets the Boolean property value that specifies whether XML indexes are included in the generated script.

Zum Anfang

Methoden

  Name Beschreibung
Öffentliche Methode Add(ScriptOption) Adds a ScriptOption object to the ScriptingOptions object.
Öffentliche MethodeStatisches Element Add(ScriptingOptions, ScriptOption) Adds the specified ScriptOption and ScriptingOptions objects to the ScriptingOptions.
Öffentliche MethodeStatisches Element ConvertVersion Converts the server version to a SqlServerVersion value.
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode Finalize (Geerbt von Object.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Öffentliche Methode GetType (Geerbt von Object.)
Geschützte Methode MemberwiseClone (Geerbt von Object.)
Öffentliche Methode Remove Removes a ScriptOption object from the ScriptingOptions object.
Öffentliche Methode SetTargetDatabaseEngineType Sets the database engine type as specified in a DatabaseEngineType object.
Öffentliche Methode SetTargetServerVersion Sets the version of the instance of SQL Server on which the scripting operation is run.
Öffentliche MethodeStatisches Element Subtract Subtracts the specified ScriptOption value from the specified ScriptingOptions object.
Öffentliche Methode ToString Returns a string that represents the ScriptingOptions object. (Überschreibt Object. . :: . .ToString() () () ().)

Zum Anfang

Operatoren

  Name Beschreibung
Öffentlicher OperatorStatisches Element Addition Creates a set of scripting options by performing an addition operation on a ScriptingOptions object and a ScriptOption object.
Öffentlicher OperatorStatisches Element Subtraction Creates a set of scripting options by performing an subtraction operation on a ScriptingOptions object and a ScriptOption object.

Zum Anfang

Hinweise

VorsichtshinweisVorsicht

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

Thread Safety

Alle öffentlichen, statischen Elemente dieses Typs (Shared in Microsoft Visual Basic) sind für Vorgänge mit mehreren Threads sicher. Für Instanzelemente kann nicht sichergestellt werden, dass sie für Threads sicher sind.

Beispiele

'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

PowerShell

$srv = New-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")
$scrp = New-Object Microsoft.SqlServer.Management.Smo.Scripter($srv)
$scrp.Options.ScriptDrops = $FALSE
$scrp.Options.WithDependencies = $TRUE
$tb = New-Object Microsoft.SqlServer.Management.Smo.Table
#$smoObjects = new-object Microsoft.SqlServer.Management.Smo.Urn[]0
$smoObjects = $tb.Urn
foreach ($tb in $db.Tables)
{
   $smoObjects = $tb.Urn
   if ($tb.IsSystemObject -eq $FALSE)
   {
      $sc = $scrp.Script($smoObjects)
      foreach ($st in $sc)
      {
         Write-Host $st
      }
   }
}

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Andere Ressourcen