Export (0) Print
Expand All

ScriptOption Class

The ScriptOption object represents the SQL Server script options that can be included in scripting options that are set by using the ScriptingOptions object.

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

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

public sealed class ScriptOption

The ScriptOption type exposes the following members.

  NameDescription
Public propertyStatic memberAgentAlertJobGets an object that specifies whether to include SQL Server Agent alerts and jobs in the script. 
Public propertyStatic memberAgentJobIdGets an object that specifies whether to include SQL Server Agent alerts and jobs in the script. 
Public propertyStatic memberAgentNotifyGets an object that specifies whether to include notifications for any SQL Server Agent alerts that in the script. 
Public propertyStatic memberAllowSystemObjectsGets an object that specifies whether system objects can be scripted or not.
Public propertyStatic memberAnsiFileGets an object that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters meaning.
Public propertyStatic memberAnsiPaddingGets an object 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.
Public propertyStatic memberAppendToFileGets an object that specifies whether the script is appended to the end of the output file or overwrites it.
Public propertyStatic memberBindingsGets an object that specifies whether the binding statements sp_binddefault and sp_bindrule are included in the generated script. This property applies only when scripting a Microsoft SQL Server table.
Public propertyStatic memberChangeTrackingGets the ChangeTracking property value.
Public propertyStatic memberClusteredIndexesGets an object that specifies whether statements that define clustered indexes are included in the generated script.
Public propertyStatic memberContinueScriptingOnErrorGets an object value that specifies whether the scripting operation continues after an error is encountered.
Public propertyStatic memberConvertUserDefinedDataTypesToBaseTypeGets an object value that specifies whether user-defined data types are converted to the most appropriate SQL Server base data types in the generated script. 
Public propertyStatic memberDdlBodyOnlyGets an object 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.
Public propertyStatic memberDdlHeaderOnlyGets an object 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.
Public propertyStatic memberDefaultGets an object value that specifies whether the creation of the referenced object is included in the generated script.
Public propertyStatic memberDriAllGets an object value that specifies whether the DRI objects are included in the generated script.
Public propertyStatic memberDriAllConstraintsGets an object value that specifies whether all DRI constraints are included in the generated script.
Public propertyStatic memberDriAllKeysGets an object value that specifies whether all DRI keys (DriForeignKeys, DriPrimaryKey, DriUniqueKeys) are included in the generated script.
Public propertyStatic memberDriChecksGets an object value that specifies whether column-specific dependency relationships defined in check constraints with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriClusteredGets an object value that specifies whether dependency relationships defined in clustered indexes with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriDefaultsGets an object value that specifies whether dependency relationships defined in defaults with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriForeignKeysGets an object value that specifies whether dependency relationships defined in foreign keys with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriIncludeSystemNamesGets an object value that specifies whether the system generated constraint names used to enforce declarative referential integrity are included in the script.
Public propertyStatic memberDriIndexesGets an object value that specifies whether PRIMARY KEY constraints using a unique index to implement the declarative referential integrity are included in the generated script.
Public propertyStatic memberDriNonClusteredGets an object value that specifies whether dependency relationships defined in non-clustered indexes with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriPrimaryKeyGets an object value that specifies whether dependency relationships defined in primary keys with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriUniqueKeysGets an object value that specifies whether dependency relationships defined in unique keys with enforced declarative referential integrity are included in the script.
Public propertyStatic memberDriWithNoCheckGets an object value that specifies whether the no check statement is included in the script.
Public propertyStatic memberEnforceScriptingOptionsGets an object value that specifies whether the application of all scripting options is enforced for text base objects, such as SchemaQualify.
Public propertyStatic memberExtendedPropertiesGets an object value that specifies whether extended object properties are included in the generated script.
Public propertyStatic memberFullTextCatalogsGets an object value that specifies whether full-text catalogs are included in the generated script.
Public propertyStatic memberFullTextIndexesGets an object value that specifies whether full-text indexes are included in the generated script.
Public propertyStatic memberFullTextStopListsGets an object value that specifies whether full-text stop lists are included in the generated script.
Public propertyStatic memberIncludeDatabaseContextGets an object value that specifies whether database content is included in the generated script.
Public propertyStatic memberIncludeDatabaseRoleMembershipsGets the IncludeDatabaseRoleMemberships property value.
Public propertyStatic memberIncludeFullTextCatalogRootPathGets the IncludeFullTextCatalogRootPath property value.
Public propertyStatic memberIncludeHeadersGets an object that specifies whether the generated script is prefixed with a header containing information including the date and time of generation.
Public propertyStatic memberIncludeIfNotExistsGets an object that specifies whether to check the existence of an object before including it in the script.
Public propertyStatic memberIndexesGets an object that specifies whether indexes are included in the generated script.
Public propertyStatic memberLoginSidGets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.
Public propertyStatic memberNoAssembliesGets an object that specifies whether assemblies are excluded from the generated script.
Public propertyStatic memberNoCollationGets an object value that specifies whether to include the collection in the generated script if the server is running SQL Server 7.0 or later.
Public propertyStatic memberNoCommandTerminatorGets an object value that specifies whether individual Transact-SQL statements are delimited in the generated script.
Public propertyStatic memberNoExecuteAsGets an object value that specifies whether the EXECUTE AS options for stored procedures and user-defined functions are included in the script.
Public propertyStatic memberNoFileGroupGets an object value that specifies whether to include the 'ON <filegroup>' clause in the generated script.
Public propertyStatic memberNoFileStreamGets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
Public propertyStatic memberNoFileStreamColumnGets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
Public propertyStatic memberNoIdentitiesGets an object value that specifies whether definitions of identity property seed and increment are included in the generated script.
Public propertyStatic memberNoIndexPartitioningSchemesGets an object value that specifies whether partition schemes for indexes are included in the generated script.
Public propertyStatic memberNoMailProfileAccountsGets an object value that specifies whether mail accounts referenced by mail profiles are included in the generated script.
Public propertyStatic memberNoMailProfilePrincipalsGets an object value that specifies whether principals referenced by mail profiles are excluded from the generated script.
Public propertyStatic memberNonClusteredIndexesGets an object value that specifies whether non-clustered indexes are included in the generated script.
Public propertyStatic memberNoTablePartitioningSchemesGets an object value that specifies whether partition schemes for tables are included in the generated script.
Public propertyStatic memberNoVardecimalGets the NoVardecimal property value.
Public propertyStatic memberNoViewColumnsGets an object value that specifies whether to include the specified columns for a view.
Public propertyStatic memberNoXmlNamespacesGets an object value that specifies whether XML namespaces are included in the generated script.
Public propertyStatic memberOptimizerDataGets an object value that specifies whether script optimizer data for the referenced objects are included in the generated script.
Public propertyStatic memberPermissionsGets an object value that specifies whether to all permissions in the generated script.
Public propertyStatic memberPrimaryObjectGets an object value that specifies whether the creation of the referenced object is included in the generated script.
Public propertyStatic memberSchemaQualifyGets an object value that specifies whether the script contains object with no schema.
Public propertyStatic memberSchemaQualifyForeignKeysReferencesGets an object value that specifies whether tables with no schema that are referenced by a foreign key are included in the generated script.
Public propertyStatic memberScriptBatchTerminatorGets the batch terminator of the script option.
Public propertyStatic memberScriptDataGets the ScriptData property value.
Public propertyStatic memberScriptDataCompressionGets an object value that specifies whether the creation of the referenced object is included in the generated script.
Public propertyStatic memberScriptOwnerGets an object value that specifies whether the creation of the referenced object is included in the generated script.
Public propertyStatic memberScriptSchemaGets the schema of the script option.
Public propertyStatic memberStatisticsGets an object value that specifies whether statistics are generated for any table or view included in the generated script.
Public propertyStatic memberTimestampToBinaryGets an object value that specifies whether to convert timestamp data types to a binary(8) data types when scripting the creation of a table or user defined data type.
Public propertyStatic memberToFileOnlyGets an object value that specifies whether to output to file only or to generate string output too.
Public propertyStatic memberTriggersGets an object value that specifies whether to include the definition for triggers in the generated script.
Public propertyStatic memberWithDependenciesGets an object value that specifies whether to include all dependent objects in the generated script.
Public propertyStatic memberXmlIndexesGets an object value that specifies whether XML indexes are included in the generated script.
Top

  NameDescription
Public methodStatic memberAddAdds the two ScriptOption objects to create a ScriptOptions object.
Public methodStatic memberBitwiseOrCombines two ScriptingOptions object using a Bitwise OR operation.
Public methodEqualsReturns a Boolean value that specifies if two ScriptOptions are equal. (Overrides Object.Equals(Object).)
Public methodGetHashCodeReturns the hash code for this object. (Overrides Object.GetHashCode().)
Public methodGetType (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Overrides Object.ToString().)
Top

  NameDescription
Public operatorStatic memberAdditionCreates a set of scripting options by performing an addition operation on two ScriptOption objects.
Public operatorStatic memberBitwiseOrCreates a set of scripting options by performing a bitwise OR operation on two ScriptOption objects.
Public operatorStatic memberImplicit(ScriptOption to ScriptingOptions)Implicitly converts the specified ScriptOption to a ScriptingOptions object.
Top

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

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft