ScriptOption Members

  • Article

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

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

Public Properties

  Name Description
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif AgentAlertJob Gets an object that specifies whether to include SQL Server Agent alerts and jobs in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif AgentJobId Gets an object that specifies whether to include SQL Server Agent alerts and jobs in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif AgentNotify Gets an object that specifies whether to include notifications for any SQL Server Agent alerts that in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif AllowSystemObjects Gets an object that specifies whether system objects can be scripted or not.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif AnsiFile Gets an object that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters meaning.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif AppendToFile Gets an object that specifies whether the script is appended to the end of the output file or overwrites it.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif ClusteredIndexes Gets an object that specifies whether statements that define clustered indexes are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif ContinueScriptingOnError Gets an object value that specifies whether the scripting operation continues after an error is encountered.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif ConvertUserDefinedDataTypesToBaseType Gets an object value that specifies whether user-defined data types are converted to the most appropriate Microsoft SQL Server base data types in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif Default Gets an object value that specifies whether the creation of the referenced object is included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriAll Gets an object value that specifies whether the DRI objects are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriAllConstraints Gets an object value that specifies whether all DRI constraints are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriAllKeys Gets an object value that specifies whether all DRI keys (DriForeignKeys, DriPrimaryKey, DriUniqueKeys) are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriClustered Gets an object value that specifies whether dependency relationships defined in clustered indexes with enforced declarative referential integrity are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriDefaults Gets an object value that specifies whether dependency relationships defined in defaults with enforced declarative referential integrity are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriForeignKeys Gets an object value that specifies whether dependency relationships defined in foreign keys with enforced declarative referential integrity are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriIncludeSystemNames Gets an object value that specifies whether the system generated constraint names used to enforce declarative referential integrity are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriPrimaryKey Gets an object value that specifies whether dependency relationships defined in primary keys with enforced declarative referential integrity are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriUniqueKeys Gets an object value that specifies whether dependency relationships defined in unique keys with enforced declarative referential integrity are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif DriWithNoCheck Gets an object value that specifies whether the no check statement is included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif EnforceScriptingOptions Gets an object value that specifies whether the application of all scripting options is enforced for text base objects, such as SchemaQualify.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif ExtendedProperties Gets an object value that specifies whether extended object properties are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif FullTextCatalogs Gets an object value that specifies whether full-text catalogs are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif FullTextIndexes Gets an object value that specifies whether full-text indexes are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif IncludeDatabaseContext Gets an object value that specifies whether database content is included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif IncludeHeaders Gets an object that specifies whether the generated script is prefixed with a header containing information including the date and time of generation.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif IncludeIfNotExists Gets an object that specifies whether to check the existence of an object before including it in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif Indexes Gets an object that specifies whether indexes are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif LoginSid Gets an object value that specifies whether assemblies are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoAssemblies Gets an object that specifies whether assemblies are excluded from the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoCommandTerminator Gets an object value that specifies whether individual Transact-SQL statements are delimited in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoExecuteAs Gets an object value that specifies whether the EXECUTE AS options for stored procedures and user-defined functions are included in the script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoFileGroup Gets an object value that specifies whether to include the 'ON <filegroup>' clause in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoIdentities Gets an object value that specifies whether definitions of identity property seed and increment are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoIndexPartitioningSchemes Gets an object value that specifies whether partition schemes for indexes are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoMailProfileAccounts Gets an object value that specifies whether mail accounts referenced by mail profiles are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoMailProfilePrincipals Gets an object value that specifies whether principals referenced by mail profiles are excluded from the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NonClusteredIndexes Gets an object value that specifies whether non-clustered indexes are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoTablePartitioningSchemes Gets an object value that specifies whether partition schemes for tables are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoViewColumns Gets an object value that specifies whether to include the specified columns for a view.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif NoXmlNamespaces Gets an object value that specifies whether XML namespaces are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif OptimizerData Gets an object value that specifies whether script optimizer data for the referenced objects are included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif Permissions Gets an object value that specifies whether to all permissions in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif PrimaryObject Gets an object value that specifies whether the creation of the referenced object is included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif SchemaQualify Gets an object value that specifies whether the script contains object with no schema.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif Statistics Gets an object value that specifies whether statistics are generated for any table or view included in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif 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.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif ToFileOnly Gets an object value that specifies whether to output to file only or to generate string output too.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif Triggers Gets an object value that specifies whether to include the definition for triggers in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif WithDependencies Gets an object value that specifies whether to include all dependent objects in the generated script.
ms220214.pubproperty(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif XmlIndexes Gets an object value that specifies whether XML indexes are included in the generated script.

Top

Public Methods

(see also Protected Methods )

  Name Description
ms220214.pubmethod(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif Add  
ms220214.pubmethod(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif BitwiseOr  
ms220214.pubmethod(en-US,SQL.90).gif Equals Overloaded. Overridden.  
ms220214.pubmethod(en-US,SQL.90).gif GetHashCode Overridden. Returns the hash code for this object.
ms220214.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms220214.pubmethod(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif op_Addition Creates a set of scripting options by performing an addition operation on two ScriptOption objects.
ms220214.pubmethod(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif op_BitwiseOr Creates a set of scripting options by performing a bitwise OR operation on two ScriptOption objects.
ms220214.pubmethod(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif op_Implicit  
ms220214.pubmethod(en-US,SQL.90).gifms220214.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms220214.pubmethod(en-US,SQL.90).gif ToString Overridden.  

Top

Protected Methods

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

Top

See Also

Reference

ScriptOption Class
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

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