ScriptingOptions 类

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

继承层次结构

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

命名空间:  Microsoft.SqlServer.Management.Smo
程序集:  Microsoft.SqlServer.Smo(在 Microsoft.SqlServer.Smo.dll 中)

语法

声明
Public NotInheritable Class ScriptingOptions
用法
Dim instance As ScriptingOptions
public sealed class ScriptingOptions
public ref class ScriptingOptions sealed
[<SealedAttribute>]
type ScriptingOptions =  class end
public final class ScriptingOptions

ScriptingOptions 类型公开以下成员。

构造函数

  名称 说明
公共方法 ScriptingOptions() () () () Initializes a new instance of the ScriptingOptions class.
公共方法 ScriptingOptions(ScriptingOptions) Initializes a new instance of the ScriptingOptions class based on the specified scripting options.
公共方法 ScriptingOptions(ScriptOption) Initializes a new instance of the ScriptingOptions class based on the specified ScriptOption object, based on the specified script option.

页首

属性

  名称 说明
公共属性 AgentAlertJob Gets or sets the Boolean property that specifies whether to include SQL Server Agent job name for alert objects in the script.
公共属性 AgentJobId Gets or sets the Boolean property that specifies whether to include SQL Server Agent job ID values for alert objects in the script.
公共属性 AgentNotify Gets or sets the Boolean property that specifies whether to include notifications for any SQL Server Agent alerts that are in the script.
公共属性 AllowSystemObjects Gets or sets the Boolean property that specifies whether system objects can be scripted.
公共属性 AnsiFile Gets or sets the Boolean property that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters' meaning.
公共属性 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.
公共属性 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.
公共属性 BatchSize Gets or sets the number of statements after which to script batch terminator.
公共属性 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.
公共属性 ChangeTracking Gets or sets the ChangeTracking property value.
公共属性 ClusteredIndexes Gets or sets a Boolean property value that specifies whether statements that define clustered indexes are included in the generated script.
公共属性 ContinueScriptingOnError Gets or sets the Boolean property value that specifies whether the scripting operation continues after an error is encountered.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 Default Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.
公共属性 DriAll Gets or sets the Boolean property value that specifies whether all DRI objects are included in the generated script.
公共属性 DriAllConstraints Gets or sets the Boolean property value that specifies whether all declarative referential integrity constraints are included in the generated script.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 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.
公共属性 DriWithNoCheck Gets or sets the Boolean property value that specifies whether the no check statement is included in the script.
公共属性 Encoding Gets or sets the encoding for the scripting options.
公共属性 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.
公共属性 ExtendedProperties Gets or sets the Boolean property value that specifies whether extended object properties are included in the generated script.
公共属性 FileName Gets or sets the name of the file to which the generated script is output.
公共属性 FullTextCatalogs Gets or sets the Boolean property value that specifies whether full-text catalogs are included in the generated script.
公共属性 FullTextIndexes Gets or sets the Boolean property value that specifies whether full-text indexes are included in the generated script.
公共属性 FullTextStopLists Gets or sets the Boolean property value that specifies whether full-text stop lists are included in the generated script.
公共属性 IncludeDatabaseContext Gets or sets the Boolean property value that specifies whether database content is included in the generated script.
公共属性 IncludeDatabaseRoleMemberships Gets or sets the IncludeDatabaseRoleMemberships property value.
公共属性 IncludeFullTextCatalogRootPath Gets or sets the IncludeFullTextCatalogRootPath property value.
公共属性 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.
公共属性 IncludeIfNotExists Gets or sets a Boolean property value that specifies whether to check the existence of an object before including it in the script.
公共属性 Indexes Gets or sets the Boolean property value that specifies whether indexes are included in the generated script.
公共属性 LoginSid Gets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.
公共属性 NoAssemblies Gets or sets the Boolean property value that specifies whether assemblies are included in the generated script.
公共属性 NoCollation Gets or sets the Boolean property value that specifies whether to include the collation clause in the generated script.
公共属性 NoCommandTerminator Gets or sets the Boolean property value that specifies whether individual Transact-SQL statements are delimited in the generated script.
公共属性 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.
公共属性 NoFileGroup Gets or sets the Boolean property value that specifies whether to include the 'ON <filegroup>' clause in the generated script.
公共属性 NoFileStream Gets or sets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
公共属性 NoFileStreamColumn Gets or sets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
公共属性 NoIdentities Gets or sets the Boolean property value that specifies whether definitions of identity property seed and increment are included in the generated script.
公共属性 NoIndexPartitioningSchemes Gets or sets the Boolean property value that specifies whether partition schemes for indexes are included in the generated script.
公共属性 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.
公共属性 NoMailProfilePrincipals Gets or sets the Boolean property value that specifies whether principals that are referenced by mail profiles are included in the generated script.
公共属性 NonClusteredIndexes Gets or sets the Boolean property value that specifies whether non-clustered indexes are included in the generated script.
公共属性 NoTablePartitioningSchemes Gets or sets the Boolean property value that specifies whether partition schemes for tables are included in the generated script.
公共属性 NoVardecimal Gets or sets an object that specifies whether to include the N clause when you create vardecimal columns in the generated script.
公共属性 NoViewColumns Gets or sets the Boolean property value that specifies whether to include the specified columns for a view.
公共属性 NoXmlNamespaces Gets or sets the Boolean property value that specifies whether XML namespaces are included in the generated script.
公共属性 OptimizerData Gets or sets the Boolean property value that specifies whether script optimizer data for the referenced objects are included in the generated script.
公共属性 Permissions Gets or sets the Boolean property value that specifies whether to include all permissions in the generated script.
公共属性 PrimaryObject Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.
公共属性 SchemaQualify Gets or sets the Boolean property value that specifies whether the schemas associated with objects are included in the generated script.
公共属性 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.
公共属性 ScriptBatchTerminator Gets or sets the ScriptBatchTerminator property value.
公共属性 ScriptData Gets or sets the ScriptData property value.
公共属性 ScriptDataCompression Gets or sets the Boolean property value that specifies whether to include data compression information in the generated script.
公共属性 ScriptDrops Gets or sets the Boolean property value that specifies whether the script operation generates a Transact-SQL script to remove the referenced component.
公共属性 ScriptOwner Gets or sets the Boolean property value that specifies whether the script owner is included in the generated script.
公共属性 ScriptSchema Gets or set the ScriptSchema property value.
公共属性 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.
公共属性 TargetServerVersion Gets or sets the version of the instance of SQL Server for which the generated script is intended.
公共属性 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.
公共属性 ToFileOnly Gets or sets the Boolean property value that specifies whether to output to file only or to also generate string output.
公共属性 Triggers Gets or sets the Boolean property value that specifies whether to include the definition for triggers in the generated script.
公共属性 WithDependencies Gets or sets the Boolean property value that specifies whether to include all dependent objects in the generated script.
公共属性 XmlIndexes Gets or sets the Boolean property value that specifies whether XML indexes are included in the generated script.

页首

方法

  名称 说明
公共方法 Add(ScriptOption) Adds a ScriptOption object to the ScriptingOptions object.
公共方法静态成员 Add(ScriptingOptions, ScriptOption) Adds a ScriptingOption to a ScriptingOptions object.
公共方法静态成员 ConvertVersion
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Object 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法 GetType (从 Object 继承。)
受保护方法 MemberwiseClone (从 Object 继承。)
公共方法 Remove Removes a ScriptOption object from the ScriptingOptions object.
公共方法 SetTargetServerVersion Sets the version of the instance of SQL Server on which the scripting operation is run.
公共方法静态成员 Subtract Removes a ScriptingOption from a ScriptingOptions object.
公共方法 ToString Returns a string that represents the ScriptingOptions object. (覆盖 Object. . :: . .ToString() () () ()。)

页首

运算符

  名称 说明
公共运算符静态成员 Addition Creates a set of scripting options by performing an addition operation on a ScriptingOptions object and a ScriptOption object.
公共运算符静态成员 Subtraction Creates a set of scripting options by performing an subtraction operation on a ScriptingOptions object and a ScriptOption object.

页首

注释

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

Thread Safety

此类型的任何公共静态(Microsoft Visual Basic 中的 Shared)成员在多线程操作中是安全的。 不保证所有实例成员都对于线程安全的。

示例

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks database.
Dim db As Database
db = srv.Databases("AdventureWorks")
'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

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。