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.

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

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

[<Sealed>]
type ScriptOption = class end

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticAgentAlertJob

Gets an object that specifies whether to include SQL Server Agent alerts and jobs in the script. 

System_CAPS_pubpropertySystem_CAPS_staticAgentJobId

Gets an object that specifies whether to include SQL Server Agent alerts and jobs in the script. 

System_CAPS_pubpropertySystem_CAPS_staticAgentNotify

Gets an object that specifies whether to include notifications for any SQL Server Agent alerts that in the script. 

System_CAPS_pubpropertySystem_CAPS_staticAllowSystemObjects

Gets an object that specifies whether system objects can be scripted or not.

System_CAPS_pubpropertySystem_CAPS_staticAnsiFile

Gets an object that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters meaning.

System_CAPS_pubpropertySystem_CAPS_staticAnsiPadding

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticAppendToFile

Gets an object that specifies whether the script is appended to the end of the output file or overwrites it.

System_CAPS_pubpropertySystem_CAPS_staticBindings

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticChangeTracking

Gets the ChangeTracking property value.

System_CAPS_pubpropertySystem_CAPS_staticClusteredIndexes

Gets an object that specifies whether statements that define clustered indexes are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticContinueScriptingOnError

Gets an object value that specifies whether the scripting operation continues after an error is encountered.

System_CAPS_pubpropertySystem_CAPS_staticConvertUserDefinedDataTypesToBaseType

Gets 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. 

System_CAPS_pubpropertySystem_CAPS_staticDdlBodyOnly

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticDdlHeaderOnly

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticDefault

Gets an object value that specifies whether the creation of the referenced object is included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticDriAll

Gets an object value that specifies whether the DRI objects are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticDriAllConstraints

Gets an object value that specifies whether all DRI constraints are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticDriAllKeys

Gets an object value that specifies whether all DRI keys (DriForeignKeys, DriPrimaryKey, DriUniqueKeys) are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticDriChecks

Gets an object value that specifies whether column-specific dependency relationships defined in check constraints with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriClustered

Gets an object value that specifies whether dependency relationships defined in clustered indexes with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriDefaults

Gets an object value that specifies whether dependency relationships defined in defaults with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriForeignKeys

Gets an object value that specifies whether dependency relationships defined in foreign keys with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriIncludeSystemNames

Gets an object value that specifies whether the system generated constraint names used to enforce declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriIndexes

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticDriNonClustered

Gets an object value that specifies whether dependency relationships defined in non-clustered indexes with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriPrimaryKey

Gets an object value that specifies whether dependency relationships defined in primary keys with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriUniqueKeys

Gets an object value that specifies whether dependency relationships defined in unique keys with enforced declarative referential integrity are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticDriWithNoCheck

Gets an object value that specifies whether the no check statement is included in the script.

System_CAPS_pubpropertySystem_CAPS_staticEnforceScriptingOptions

Gets an object value that specifies whether the application of all scripting options is enforced for text base objects, such as SchemaQualify.

System_CAPS_pubpropertySystem_CAPS_staticExtendedProperties

Gets an object value that specifies whether extended object properties are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticFullTextCatalogs

Gets an object value that specifies whether full-text catalogs are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticFullTextIndexes

Gets an object value that specifies whether full-text indexes are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticFullTextStopLists

Gets an object value that specifies whether full-text stop lists are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticIncludeDatabaseContext

Gets an object value that specifies whether database content is included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticIncludeDatabaseRoleMemberships

Gets the IncludeDatabaseRoleMemberships property value.

System_CAPS_pubpropertySystem_CAPS_staticIncludeFullTextCatalogRootPath

Gets the IncludeFullTextCatalogRootPath property value.

System_CAPS_pubpropertySystem_CAPS_staticIncludeHeaders

Gets an object that specifies whether the generated script is prefixed with a header containing information including the date and time of generation.

System_CAPS_pubpropertySystem_CAPS_staticIncludeIfNotExists

Gets an object that specifies whether to check the existence of an object before including it in the script.

System_CAPS_pubpropertySystem_CAPS_staticIndexes

Gets an object that specifies whether indexes are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticLoginSid

Gets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoAssemblies

Gets an object that specifies whether assemblies are excluded from the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoCollation

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticNoCommandTerminator

Gets an object value that specifies whether individual Transact-SQL statements are delimited in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoExecuteAs

Gets an object value that specifies whether the EXECUTE AS options for stored procedures and user-defined functions are included in the script.

System_CAPS_pubpropertySystem_CAPS_staticNoFileGroup

Gets an object value that specifies whether to include the 'ON <filegroup>' clause in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoFileStream

Gets an object that specifies whether to include the FILESTREAM_ON clause when you create T:Microsoft.SqlServer.Management.Smo.DataType.VarBinaryMax columns in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoFileStreamColumn

Gets an object that specifies whether to include the FILESTREAM_ON clause when you create T:Microsoft.SqlServer.Management.Smo.DataType.VarBinaryMax columns in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoIdentities

Gets an object value that specifies whether definitions of identity property seed and increment are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoIndexPartitioningSchemes

Gets an object value that specifies whether partition schemes for indexes are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoMailProfileAccounts

Gets an object value that specifies whether mail accounts referenced by mail profiles are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoMailProfilePrincipals

Gets an object value that specifies whether principals referenced by mail profiles are excluded from the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNonClusteredIndexes

Gets an object value that specifies whether non-clustered indexes are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoTablePartitioningSchemes

Gets an object value that specifies whether partition schemes for tables are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticNoVardecimal

Gets the NoVardecimal property value.

System_CAPS_pubpropertySystem_CAPS_staticNoViewColumns

Gets an object value that specifies whether to include the specified columns for a view.

System_CAPS_pubpropertySystem_CAPS_staticNoXmlNamespaces

Gets an object value that specifies whether XML namespaces are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticOptimizerData

Gets an object value that specifies whether script optimizer data for the referenced objects are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticPermissions

Gets an object value that specifies whether to all permissions in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticPrimaryObject

Gets an object value that specifies whether the creation of the referenced object is included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticSchemaQualify

Gets an object value that specifies whether the script contains object with no schema.

System_CAPS_pubpropertySystem_CAPS_staticSchemaQualifyForeignKeysReferences

Gets an object value that specifies whether tables with no schema that are referenced by a foreign key are included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticScriptBatchTerminator

Gets the batch terminator of the script option.

System_CAPS_pubpropertySystem_CAPS_staticScriptData

Gets the ScriptData property value.

System_CAPS_pubpropertySystem_CAPS_staticScriptDataCompression

Gets an object value that specifies whether the creation of the referenced object is included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticScriptOwner

Gets an object value that specifies whether the creation of the referenced object is included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticScriptSchema

Gets the schema of the script option.

System_CAPS_pubpropertySystem_CAPS_staticStatistics

Gets an object value that specifies whether statistics are generated for any table or view included in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticTimestampToBinary

Gets 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.

System_CAPS_pubpropertySystem_CAPS_staticToFileOnly

Gets an object value that specifies whether to output to file only or to generate string output too.

System_CAPS_pubpropertySystem_CAPS_staticTriggers

Gets an object value that specifies whether to include the definition for triggers in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticWithDependencies

Gets an object value that specifies whether to include all dependent objects in the generated script.

System_CAPS_pubpropertySystem_CAPS_staticXmlIndexes

Gets an object value that specifies whether XML indexes are included in the generated script.

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticAdd(ScriptOption, ScriptOption)

Adds the two ScriptOption objects to create a ScriptOptions object.

System_CAPS_pubmethodSystem_CAPS_staticBitwiseOr(ScriptOption, ScriptOption)

Combines two ScriptingOptions object using a Bitwise OR operation.

System_CAPS_pubmethodEquals(Object)

Returns a Boolean value that specifies if two ScriptOptions are equal.(Overrides Object.Equals(Object).)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this object.(Overrides Object.GetHashCode().)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Overrides Object.ToString().)

NameDescription
System_CAPS_puboperatorSystem_CAPS_staticAddition(ScriptOption, ScriptOption)

Creates a set of scripting options by performing an addition operation on two ScriptOption objects.

System_CAPS_puboperatorSystem_CAPS_staticBitwiseOr(ScriptOption, ScriptOption)

Creates a set of scripting options by performing a bitwise OR operation on two ScriptOption objects.

System_CAPS_puboperatorSystem_CAPS_staticImplicit(ScriptOption to ScriptingOptions)

Implicitly converts the specified ScriptOption to a ScriptingOptions object.

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.

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.

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

Return to top
Show: