• Article

ScriptingOptions Members

Include Protected Members
Include Inherited Members

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

The ScriptingOptions type exposes the following members.

Constructors

  Name Description
Public method ScriptingOptions() Initializes a new instance of the ScriptingOptions class.
Public method ScriptingOptions(ScriptingOptions) Initializes a new instance of the ScriptingOptions class based on the specified scripting options.
Public method ScriptingOptions(ScriptOption) Initializes a new instance of the ScriptingOptions class based on the specified ScriptOption object, based on the specified script option.

Top

Methods

  Name Description
Public method Add(ScriptOption) Adds a ScriptOption object to the ScriptingOptions object.
Public methodStatic member Add(ScriptingOptions, ScriptOption) Adds a ScriptingOption to a ScriptingOptions object.
Public methodStatic member ConvertVersion(Version)
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Public method GetHashCode() (Inherited from Object.)
Public method GetType() (Inherited from Object.)
Protected method MemberwiseClone() (Inherited from Object.)
Public method Remove(ScriptOption) Removes a ScriptOption object from the ScriptingOptions object.
Public method SetTargetServerVersion(ServerVersion) Sets the version of the instance of SQL Server on which the scripting operation is run.
Public methodStatic member Subtract(ScriptingOptions, ScriptOption) Removes a ScriptingOption from a ScriptingOptions object.
Public method ToString() Returns a string that represents the ScriptingOptions object. (Overrides Object.ToString().)

Top

Operators

  Name Description
Public operatorStatic member Addition(ScriptingOptions, ScriptOption) Creates a set of scripting options by performing an addition operation on a ScriptingOptions object and a ScriptOption object.
Public operatorStatic member Subtraction(ScriptingOptions, ScriptOption) Creates a set of scripting options by performing an subtraction operation on a ScriptingOptions object and a ScriptOption object.

Top

Properties

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

Top