Compartir a través de


Clase ScriptingOptions

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

Jerarquía de herencia

System.Object
  Microsoft.SqlServer.Management.Smo.ScriptingOptions

Espacio de nombres:  Microsoft.SqlServer.Management.Smo
Ensamblado:  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Sintaxis

'Declaración
Public NotInheritable Class ScriptingOptions
'Uso
Dim instance As ScriptingOptions
public sealed class ScriptingOptions
public ref class ScriptingOptions sealed
[<SealedAttribute>]
type ScriptingOptions =  class end
public final class ScriptingOptions

El tipo ScriptingOptions expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público ScriptingOptions() Initializes a new instance of the ScriptingOptions class.
Método público ScriptingOptions(ScriptingOptions) Initializes a new instance of the ScriptingOptions class based on the specified scripting options.
Método público ScriptingOptions(ScriptOption) Initializes a new instance of the ScriptingOptions class based on the specified ScriptOption object, based on the specified script option.

Arriba

Propiedades

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

Arriba

Métodos

  Nombre Descripción
Método público Add(ScriptOption) Adds a ScriptOption object to the ScriptingOptions object.
Método públicoMiembro estático Add(ScriptingOptions, ScriptOption) Adds the specified ScriptOption and ScriptingOptions objects to the ScriptingOptions.
Método públicoMiembro estático ConvertVersion Converts the server version to a SqlServerVersion value.
Método público Equals (Se hereda de Object.)
Método público GetHashCode (Se hereda de Object.)
Método público GetType (Se hereda de Object.)
Método público Remove Removes a ScriptOption object from the ScriptingOptions object.
Método público SetTargetDatabaseEngineType Sets the database engine type as specified in a DatabaseEngineType object.
Método público SetTargetServerVersion Sets the version of the instance of SQL Server on which the scripting operation is run.
Método públicoMiembro estático Subtract Subtracts the specified ScriptOption value from the specified ScriptingOptions object.
Método público ToString Returns a string that represents the ScriptingOptions object. (Invalida Object.ToString().)

Arriba

Operadores

  Nombre Descripción
Operador públicoMiembro estático Addition Creates a set of scripting options by performing an addition operation on a ScriptingOptions object and a ScriptOption object.
Operador públicoMiembro estático Subtraction Creates a set of scripting options by performing an subtraction operation on a ScriptingOptions object and a ScriptOption object.

Arriba

Comentarios

Nota de advertenciaAdvertencia

Some scripting options cause the Transfer object to generate script that does not execute on the target server.

Thread Safety

Todos los miembros estáticos (compartidos en Microsoft Visual Basic) públicos de este tipo son seguros para operaciones multiproceso. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Ejemplos

'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

PowerShell

$srv = New-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
$scrp = New-Object Microsoft.SqlServer.Management.Smo.Scripter($srv)
$scrp.Options.ScriptDrops = $FALSE
$scrp.Options.WithDependencies = $TRUE
$tb = New-Object Microsoft.SqlServer.Management.Smo.Table
#$smoObjects = new-object Microsoft.SqlServer.Management.Smo.Urn[]0
$smoObjects = $tb.Urn
foreach ($tb in $db.Tables)
{
   $smoObjects = $tb.Urn
   if ($tb.IsSystemObject -eq $FALSE)
   {
      $sc = $scrp.Script($smoObjects)
      foreach ($st in $sc)
      {
         Write-Host $st
      }
   }
}

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Vea también

Referencia

Espacio de nombres Microsoft.SqlServer.Management.Smo

Otros recursos

Scripting