ScriptOption ScriptOption ScriptOption Class

Definition

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

public ref class ScriptOption sealed
public sealed class ScriptOption
Public NotInheritable Class ScriptOption
Inheritance
ScriptOptionScriptOptionScriptOption

Examples

Remarks

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.

Properties

AgentAlertJob AgentAlertJob AgentAlertJob

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

AgentJobId AgentJobId AgentJobId

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

AgentNotify AgentNotify AgentNotify

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

AllowSystemObjects AllowSystemObjects AllowSystemObjects

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

AnsiFile AnsiFile AnsiFile

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

AnsiPadding AnsiPadding AnsiPadding

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.

AppendToFile AppendToFile AppendToFile

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

Bindings Bindings Bindings

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.

ChangeTracking ChangeTracking ChangeTracking

Gets the ChangeTracking property value.

ClusteredIndexes ClusteredIndexes ClusteredIndexes

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

ContinueScriptingOnError ContinueScriptingOnError ContinueScriptingOnError

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

ConvertUserDefinedDataTypesToBaseType ConvertUserDefinedDataTypesToBaseType ConvertUserDefinedDataTypesToBaseType

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.

DdlBodyOnly DdlBodyOnly DdlBodyOnly

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.

DdlHeaderOnly DdlHeaderOnly DdlHeaderOnly

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.

Default Default Default

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

DriAll DriAll DriAll

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

DriAllConstraints DriAllConstraints DriAllConstraints

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

DriAllKeys DriAllKeys DriAllKeys

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

DriChecks DriChecks DriChecks

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.

DriClustered DriClustered DriClustered

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

DriDefaults DriDefaults DriDefaults

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

DriForeignKeys DriForeignKeys DriForeignKeys

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

DriIncludeSystemNames DriIncludeSystemNames DriIncludeSystemNames

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

DriIndexes DriIndexes DriIndexes

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.

DriNonClustered DriNonClustered DriNonClustered

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

DriPrimaryKey DriPrimaryKey DriPrimaryKey

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

DriUniqueKeys DriUniqueKeys DriUniqueKeys

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

DriWithNoCheck DriWithNoCheck DriWithNoCheck

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

EnforceScriptingOptions EnforceScriptingOptions EnforceScriptingOptions

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

ExtendedProperties ExtendedProperties ExtendedProperties

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

FullTextCatalogs FullTextCatalogs FullTextCatalogs

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

FullTextIndexes FullTextIndexes FullTextIndexes

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

FullTextStopLists FullTextStopLists FullTextStopLists

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

IncludeDatabaseContext IncludeDatabaseContext IncludeDatabaseContext

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

IncludeDatabaseRoleMemberships IncludeDatabaseRoleMemberships IncludeDatabaseRoleMemberships

Gets the IncludeDatabaseRoleMemberships property value.

IncludeFullTextCatalogRootPath IncludeFullTextCatalogRootPath IncludeFullTextCatalogRootPath

Gets the IncludeFullTextCatalogRootPath property value.

IncludeHeaders IncludeHeaders IncludeHeaders

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

IncludeIfNotExists IncludeIfNotExists IncludeIfNotExists

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

Indexes Indexes Indexes

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

LoginSid LoginSid 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 NoAssemblies NoAssemblies

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

NoCollation NoCollation NoCollation

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.

NoCommandTerminator NoCommandTerminator NoCommandTerminator

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

NoExecuteAs NoExecuteAs NoExecuteAs

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

NoFileGroup NoFileGroup NoFileGroup

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

NoFileStream NoFileStream NoFileStream

Gets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.

NoFileStreamColumn NoFileStreamColumn NoFileStreamColumn

Gets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.

NoIdentities NoIdentities NoIdentities

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

NoIndexPartitioningSchemes NoIndexPartitioningSchemes NoIndexPartitioningSchemes

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

NoMailProfileAccounts NoMailProfileAccounts NoMailProfileAccounts

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

NoMailProfilePrincipals NoMailProfilePrincipals NoMailProfilePrincipals

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

NonClusteredIndexes NonClusteredIndexes NonClusteredIndexes

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

NoTablePartitioningSchemes NoTablePartitioningSchemes NoTablePartitioningSchemes

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

NoVardecimal NoVardecimal NoVardecimal

Gets the NoVardecimal property value.

NoViewColumns NoViewColumns NoViewColumns

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

NoXmlNamespaces NoXmlNamespaces NoXmlNamespaces

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

OptimizerData OptimizerData OptimizerData

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

Permissions Permissions Permissions

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

PrimaryObject PrimaryObject PrimaryObject

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

SchemaQualify SchemaQualify SchemaQualify

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

SchemaQualifyForeignKeysReferences SchemaQualifyForeignKeysReferences SchemaQualifyForeignKeysReferences

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

ScriptBatchTerminator ScriptBatchTerminator ScriptBatchTerminator

Gets the batch terminator of the script option.

ScriptData ScriptData ScriptData

Gets the ScriptData property value.

ScriptDataCompression ScriptDataCompression ScriptDataCompression

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

ScriptOwner ScriptOwner ScriptOwner

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

ScriptSchema ScriptSchema ScriptSchema

Gets the schema of the script option.

Statistics Statistics Statistics

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

TimestampToBinary TimestampToBinary TimestampToBinary

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.

ToFileOnly ToFileOnly ToFileOnly

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

Triggers Triggers Triggers

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

WithDependencies WithDependencies WithDependencies

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

XmlIndexes XmlIndexes XmlIndexes

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

Methods

Add(ScriptOption, ScriptOption) Add(ScriptOption, ScriptOption) Add(ScriptOption, ScriptOption)

Adds the two ScriptOption objects to create a ScriptOptions object.

BitwiseOr(ScriptOption, ScriptOption) BitwiseOr(ScriptOption, ScriptOption) BitwiseOr(ScriptOption, ScriptOption)

Combines two ScriptingOptions object using a Bitwise OR operation.

Equals(Object) Equals(Object) Equals(Object)

Returns a Boolean value that specifies if two ScriptOptions are equal.

GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this object.

ToString() ToString() ToString()

Returns a string that represents the current object.

Operators

Addition(ScriptOption, ScriptOption) Addition(ScriptOption, ScriptOption) Addition(ScriptOption, ScriptOption)

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

BitwiseOr(ScriptOption, ScriptOption) BitwiseOr(ScriptOption, ScriptOption) BitwiseOr(ScriptOption, ScriptOption)

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

Implicit(ScriptOption to ScriptingOptions) Implicit(ScriptOption to ScriptingOptions) Implicit(ScriptOption to ScriptingOptions)

Implicitly converts the specified ScriptOption to a ScriptingOptions object.

Applies to