Partilhar via


Classe ScriptOption

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

Hierarquia de herança

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

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

Sintaxe

'Declaração
Public NotInheritable Class ScriptOption
'Uso
Dim instance As ScriptOption
public sealed class ScriptOption
public ref class ScriptOption sealed
[<SealedAttribute>]
type ScriptOption =  class end
public final class ScriptOption

O tipo ScriptOption expõe os membros a seguir.

Propriedades

  Nome Descrição
Propriedade públicaMembro estático AgentAlertJob Gets an object that specifies whether to include SQL Server Agent alerts and jobs in the script. 
Propriedade públicaMembro estático AgentJobId Gets an object that specifies whether to include SQL Server Agent alerts and jobs in the script. 
Propriedade públicaMembro estático AgentNotify Gets an object that specifies whether to include notifications for any SQL Server Agent alerts that in the script. 
Propriedade públicaMembro estático AllowSystemObjects Gets an object that specifies whether system objects can be scripted or not.
Propriedade públicaMembro estático AnsiFile Gets an object that specifies whether the script uses multibyte characters and requires code page 1252 to evaluate characters meaning.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático AppendToFile Gets an object that specifies whether the script is appended to the end of the output file or overwrites it.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático ChangeTracking Gets the ChangeTracking property value.
Propriedade públicaMembro estático ClusteredIndexes Gets an object that specifies whether statements that define clustered indexes are included in the generated script.
Propriedade públicaMembro estático ContinueScriptingOnError Gets an object value that specifies whether the scripting operation continues after an error is encountered.
Propriedade públicaMembro estático 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. 
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático Default Gets an object value that specifies whether the creation of the referenced object is included in the generated script.
Propriedade públicaMembro estático DriAll Gets an object value that specifies whether the DRI objects are included in the generated script.
Propriedade públicaMembro estático DriAllConstraints Gets an object value that specifies whether all DRI constraints are included in the generated script.
Propriedade públicaMembro estático DriAllKeys Gets an object value that specifies whether all DRI keys (DriForeignKeys, DriPrimaryKey, DriUniqueKeys) are included in the generated script.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático DriClustered Gets an object value that specifies whether dependency relationships defined in clustered indexes with enforced declarative referential integrity are included in the script.
Propriedade públicaMembro estático DriDefaults Gets an object value that specifies whether dependency relationships defined in defaults with enforced declarative referential integrity are included in the script.
Propriedade públicaMembro estático DriForeignKeys Gets an object value that specifies whether dependency relationships defined in foreign keys with enforced declarative referential integrity are included in the script.
Propriedade públicaMembro estático DriIncludeSystemNames Gets an object value that specifies whether the system generated constraint names used to enforce declarative referential integrity are included in the script.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático DriPrimaryKey Gets an object value that specifies whether dependency relationships defined in primary keys with enforced declarative referential integrity are included in the script.
Propriedade públicaMembro estático DriUniqueKeys Gets an object value that specifies whether dependency relationships defined in unique keys with enforced declarative referential integrity are included in the script.
Propriedade públicaMembro estático DriWithNoCheck Gets an object value that specifies whether the no check statement is included in the script.
Propriedade públicaMembro estático EnforceScriptingOptions Gets an object value that specifies whether the application of all scripting options is enforced for text base objects, such as SchemaQualify.
Propriedade públicaMembro estático ExtendedProperties Gets an object value that specifies whether extended object properties are included in the generated script.
Propriedade públicaMembro estático FullTextCatalogs Gets an object value that specifies whether full-text catalogs are included in the generated script.
Propriedade públicaMembro estático FullTextIndexes Gets an object value that specifies whether full-text indexes are included in the generated script.
Propriedade públicaMembro estático FullTextStopLists Gets an object value that specifies whether full-text stop lists are included in the generated script.
Propriedade públicaMembro estático IncludeDatabaseContext Gets an object value that specifies whether database content is included in the generated script.
Propriedade públicaMembro estático IncludeDatabaseRoleMemberships Gets the IncludeDatabaseRoleMemberships property value.
Propriedade públicaMembro estático IncludeFullTextCatalogRootPath Gets the IncludeFullTextCatalogRootPath property value.
Propriedade públicaMembro estático IncludeHeaders Gets an object that specifies whether the generated script is prefixed with a header containing information including the date and time of generation.
Propriedade públicaMembro estático IncludeIfNotExists Gets an object that specifies whether to check the existence of an object before including it in the script.
Propriedade públicaMembro estático Indexes Gets an object that specifies whether indexes are included in the generated script.
Propriedade públicaMembro estático LoginSid Gets or sets the Boolean property value that specifies whether the security identifiers are included for any scripted logins in the generated script.
Propriedade públicaMembro estático NoAssemblies Gets an object that specifies whether assemblies are excluded from the generated script.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático NoCommandTerminator Gets an object value that specifies whether individual Transact-SQL statements are delimited in the generated script.
Propriedade públicaMembro estático NoExecuteAs Gets an object value that specifies whether the EXECUTE AS options for stored procedures and user-defined functions are included in the script.
Propriedade públicaMembro estático NoFileGroup Gets an object value that specifies whether to include the 'ON <filegroup>' clause in the generated script.
Propriedade públicaMembro estático NoFileStream Gets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
Propriedade públicaMembro estático NoFileStreamColumn Gets an object that specifies whether to include the FILESTREAM_ON clause when you create VarBinaryMax columns in the generated script.
Propriedade públicaMembro estático NoIdentities Gets an object value that specifies whether definitions of identity property seed and increment are included in the generated script.
Propriedade públicaMembro estático NoIndexPartitioningSchemes Gets an object value that specifies whether partition schemes for indexes are included in the generated script.
Propriedade públicaMembro estático NoMailProfileAccounts Gets an object value that specifies whether mail accounts referenced by mail profiles are included in the generated script.
Propriedade públicaMembro estático NoMailProfilePrincipals Gets an object value that specifies whether principals referenced by mail profiles are excluded from the generated script.
Propriedade públicaMembro estático NonClusteredIndexes Gets an object value that specifies whether non-clustered indexes are included in the generated script.
Propriedade públicaMembro estático NoTablePartitioningSchemes Gets an object value that specifies whether partition schemes for tables are included in the generated script.
Propriedade públicaMembro estático NoVardecimal Gets the NoVardecimal property value.
Propriedade públicaMembro estático NoViewColumns Gets an object value that specifies whether to include the specified columns for a view.
Propriedade públicaMembro estático NoXmlNamespaces Gets an object value that specifies whether XML namespaces are included in the generated script.
Propriedade públicaMembro estático OptimizerData Gets an object value that specifies whether script optimizer data for the referenced objects are included in the generated script.
Propriedade públicaMembro estático Permissions Gets an object value that specifies whether to all permissions in the generated script.
Propriedade públicaMembro estático PrimaryObject Gets an object value that specifies whether the creation of the referenced object is included in the generated script.
Propriedade públicaMembro estático SchemaQualify Gets an object value that specifies whether the script contains object with no schema.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático ScriptBatchTerminator Gets the batch terminator of the script option.
Propriedade públicaMembro estático ScriptData Gets the ScriptData property value.
Propriedade públicaMembro estático ScriptDataCompression Gets an object value that specifies whether the creation of the referenced object is included in the generated script.
Propriedade públicaMembro estático ScriptOwner Gets an object value that specifies whether the creation of the referenced object is included in the generated script.
Propriedade públicaMembro estático ScriptSchema Gets the schema of the script option.
Propriedade públicaMembro estático Statistics Gets an object value that specifies whether statistics are generated for any table or view included in the generated script.
Propriedade públicaMembro estático 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.
Propriedade públicaMembro estático ToFileOnly Gets an object value that specifies whether to output to file only or to generate string output too.
Propriedade públicaMembro estático Triggers Gets an object value that specifies whether to include the definition for triggers in the generated script.
Propriedade públicaMembro estático WithDependencies Gets an object value that specifies whether to include all dependent objects in the generated script.
Propriedade públicaMembro estático XmlIndexes Gets an object value that specifies whether XML indexes are included in the generated script.

Início

Métodos

  Nome Descrição
Método públicoMembro estático Add Adds the two ScriptOption objects to create a ScriptOptions object.
Método públicoMembro estático BitwiseOr Combines two ScriptingOptions object using a Bitwise OR operation.
Método público Equals Returns a Boolean value that specifies if two ScriptOptions are equal. (Substitui Object.Equals(Object).)
Método público GetHashCode Returns the hash code for this object. (Substitui Object.GetHashCode().)
Método público GetType (Herdado de Object.)
Método público ToString Returns a string that represents the current object. (Substitui Object.ToString().)

Início

Operadores

  Nome Descrição
Operador públicoMembro estático Addition Creates a set of scripting options by performing an addition operation on two ScriptOption objects.
Operador públicoMembro estático BitwiseOr Creates a set of scripting options by performing a bitwise OR operation on two ScriptOption objects.
Operador públicoMembro estático Implicit(ScriptOption to ScriptingOptions) Implicitly converts the specified ScriptOption to a ScriptingOptions object.

Início

Comentários

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

Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads.

Exemplos

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Define a Scripter object and set the required scripting options.
Dim scrp As Scripter
scrp = New Scripter(srv)
scrp.Options.ScriptDrops = False
scrp.Options.WithDependencies = True
'Iterate through the tables in database and script each one. Display the script.
'Note that the StringCollection type needs the System.Collections.Specialized namespace to be included.
Dim tb As Table
Dim smoObjects(1) As Urn
For Each tb In db.Tables
    smoObjects = New Urn(0) {}
    smoObjects(0) = tb.Urn
    If tb.IsSystemObject = False Then
        Dim sc As StringCollection
        sc = scrp.Script(smoObjects)
        Dim st As String
        For Each st In sc
            Console.WriteLine(st)
        Next
    End If
Next

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo

Outros recursos

Gerando scripts