ScriptingOptions Members

  • Article

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

The following tables list the members exposed by the ScriptingOptions type.

Public Constructors

  Name Description
ScriptingOptions Overloaded. Initializes a new instance of the ScriptingOptions class.

Top

Public Properties

  Name Description
ms220187.pubproperty(en-US,SQL.90).gif AgentAlertJob Gets or sets the Boolean property that specifies whether to include SQL Server Agent job name for alert objects in the script.
ms220187.pubproperty(en-US,SQL.90).gif AgentJobId Gets or sets the Boolean property that specifies whether to include SQL Server Agent job ID values for alert objects in the script.
ms220187.pubproperty(en-US,SQL.90).gif AgentNotify Gets or sets the Boolean property that specifies whether to include notifications for any SQL Server Agent alerts that in the script.
ms220187.pubproperty(en-US,SQL.90).gif AllowSystemObjects Gets or sets the Boolean property that specifies whether system objects can be scripted or not.
ms220187.pubproperty(en-US,SQL.90).gif AnsiFile Gets or sets the Boolean property that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters meaning.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif 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 Microsoft SQL Server table.
ms220187.pubproperty(en-US,SQL.90).gif ClusteredIndexes Gets or sets a Boolean property value that specifies whether statements that define clustered indexes are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif ContinueScriptingOnError Gets or sets the Boolean property value that specifies whether the scripting operation continues after an error is encountered.
ms220187.pubproperty(en-US,SQL.90).gif ConvertUserDefinedDataTypesToBaseType Gets or sets the Boolean property value that specifies whether user-defined data types are converted to the most appropriate Microsoft SQL Server base data types in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif Default Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif DriAll Gets or sets the Boolean property value that specifies whether all DRI objects are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif DriAllConstraints Gets or sets the Boolean property value that specifies whether all DRI constraints are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif DriAllKeys Gets or sets the Boolean property value that specifies whether the dependency relationships defined by all DRI keys are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif DriChecks Gets or sets the Boolean property value that specifies whether column specific dependency relationships defined in check constraints with enforced declarative referential integrity are included in the script.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif DriIncludeSystemNames Gets or sets the Boolean property value that specifies whether the system generated constraint names used to enforce declarative referential integrity are included in the script.
ms220187.pubproperty(en-US,SQL.90).gif DriIndexes Gets or sets the Boolean property value that specifies whether PRIMARY KEY constraints using a unique index to implement the declarative referential integrity are included in the script.
ms220187.pubproperty(en-US,SQL.90).gif DriNonClustered Gets or sets the Boolean property value that specifies whether dependency relationships defined in non-clustered indexes with enforced declarative referential integrity are included in the script.
ms220187.pubproperty(en-US,SQL.90).gif DriPrimaryKey Gets or sets the Boolean property value that specifies whether dependency relationships defined in primary keys with enforced declarative referential integrity are included in the script.
ms220187.pubproperty(en-US,SQL.90).gif DriUniqueKeys Gets or sets the Boolean property value that specifies whether dependency relationships defined in unique keys with enforced declarative referential integrity are included in the script.
ms220187.pubproperty(en-US,SQL.90).gif DriWithNoCheck Gets or sets the Boolean property value that specifies whether the no check statement is included in the script.
ms220187.pubproperty(en-US,SQL.90).gif Encoding Gets or sets the encoding for the scripting options.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif ExtendedProperties Gets or sets the Boolean property value that specifies whether extended object properties are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif FileName Gets or sets the name of the file to which the generated script is output.
ms220187.pubproperty(en-US,SQL.90).gif FullTextCatalogs Gets or sets the Boolean property value that specifies whether full-text catalogs are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif FullTextIndexes Gets or sets the Boolean property value that specifies whether full-text indexes are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif IncludeDatabaseContext Gets or sets the Boolean property value that specifies whether the database context is included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif IncludeHeaders Gets or sets a Boolean property value that specifies whether the generated script is prefixed with a header containing information including the date and time of generation.
ms220187.pubproperty(en-US,SQL.90).gif IncludeIfNotExists Gets or sets a Boolean property value that specifies whether to check the existence of an object before including it in the script.
ms220187.pubproperty(en-US,SQL.90).gif Indexes Gets or sets the Boolean property value that specifies whether indexes are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif LoginSid Gets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoAssemblies Gets or sets the Boolean property value that specifies whether assemblies are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoCollation Gets or sets the Boolean property value that specifies whether to include the collection in the generated script if the server is running SQL Server 7.0 or later.
ms220187.pubproperty(en-US,SQL.90).gif NoCommandTerminator Gets or sets the Boolean property value that specifies whether individual Transact-SQL statements are delimited in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif 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.
ms220187.pubproperty(en-US,SQL.90).gif NoFileGroup Gets or sets the Boolean property value that specifies whether to include the 'ON <filegroup>' clause in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoIdentities Gets or sets the Boolean property value that specifies whether definitions of identity property seed and increment are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoIndexPartitioningSchemes Gets or sets the Boolean property value that specifies whether partition schemes for indexes are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoMailProfileAccounts Gets or sets the Boolean property value that specifies whether mail accounts referenced by mail profiles are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoMailProfilePrincipals Gets or sets the Boolean property value that specifies whether principals referenced by mail profiles are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NonClusteredIndexes Gets or sets the Boolean property value that specifies whether non-clustered indexes are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoTablePartitioningSchemes Gets or sets the Boolean property value that specifies whether partition schemes for tables are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif NoViewColumns Gets or sets the Boolean property value that specifies whether to include the specified columns for a view.
ms220187.pubproperty(en-US,SQL.90).gif NoXmlNamespaces Gets or sets the Boolean property value that specifies whether XML namespaces are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif OptimizerData Gets or sets the Boolean property value that specifies whether script optimizer data for the referenced objects are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif Permissions Gets or sets the Boolean property value that specifies whether to all permissions in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif PrimaryObject Gets or sets the Boolean property value that specifies whether the creation of the referenced object is included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif SchemaQualify Gets or sets the Boolean property value that specifies whether objects with no schema are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif SchemaQualifyForeignKeysReferences Gets or sets the Boolean property value that specifies whether schema qualify table references for foreign key constraints are included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif ScriptDrops Gets or sets the Boolean property value that specifies whether the script operation generates a Transact-SQL script to remove the referenced component.
ms220187.pubproperty(en-US,SQL.90).gif Statistics Gets or sets the Boolean property value that specifies whether statistics for any table or view that is included in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif TargetServerVersion Gets or sets the version of the instance of SQL Server for which the generated script is intended.
ms220187.pubproperty(en-US,SQL.90).gif TimestampToBinary Gets or sets the Boolean property 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.
ms220187.pubproperty(en-US,SQL.90).gif ToFileOnly Gets or sets the Boolean property value that specifies whether to output to file only or to generate string output also.
ms220187.pubproperty(en-US,SQL.90).gif Triggers Gets or sets the Boolean property value that specifies whether to include the definition for triggers in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif WithDependencies Gets or sets the Boolean property value that specifies whether to include all dependent objects in the generated script.
ms220187.pubproperty(en-US,SQL.90).gif XmlIndexes Gets or sets the Boolean property value that specifies whether XML indexes are included in the generated script.

Top

Public Methods

(see also Protected Methods )

  Name Description
ms220187.pubmethod(en-US,SQL.90).gif Add Overloaded.  
ms220187.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms220187.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms220187.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms220187.pubmethod(en-US,SQL.90).gifms220187.static(en-US,SQL.90).gif op_Addition Creates a set of scripting options by performing an addition operation on a ScriptingOptions object and a ScriptOption object.
ms220187.pubmethod(en-US,SQL.90).gifms220187.static(en-US,SQL.90).gif op_Subtraction Creates a set of scripting options by performing an subtraction operation on a ScriptingOptions object and a ScriptOption object.
ms220187.pubmethod(en-US,SQL.90).gifms220187.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms220187.pubmethod(en-US,SQL.90).gif Remove Removes a ScriptOption object from the ScriptingOptions object.
ms220187.pubmethod(en-US,SQL.90).gif SetTargetServerVersion Sets the version of the instance of SQL Server on which the scripting operation is run.
ms220187.pubmethod(en-US,SQL.90).gifms220187.static(en-US,SQL.90).gif Subtract  
ms220187.pubmethod(en-US,SQL.90).gif ToString Overridden. Returns a string that represents the ScriptingOptions object.

Top

Protected Methods

  Name Description
ms220187.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms220187.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )

Top

See Also

Reference

ScriptingOptions Class
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

How to: Script Out the Dependencies for a Database in Visual Basic .NET
Scripting