Condividi tramite


Classe ScriptingOptions

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

Gerarchia di ereditarietà

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

Spazio dei nomi  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Sintassi

'Dichiarazione
Public NotInheritable Class ScriptingOptions
'Utilizzo
Dim instance As ScriptingOptions
public sealed class ScriptingOptions
public ref class ScriptingOptions sealed
[<SealedAttribute>]
type ScriptingOptions =  class end
public final class ScriptingOptions

Nel tipo ScriptingOptions sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo pubblico ScriptingOptions() () () () Initializes a new instance of the ScriptingOptions class.
Metodo pubblico ScriptingOptions(ScriptingOptions) Initializes a new instance of the ScriptingOptions class based on the specified scripting options.
Metodo pubblico ScriptingOptions(ScriptOption) Initializes a new instance of the ScriptingOptions class based on the specified ScriptOption object, based on the specified script option.

In alto

Proprietà

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

In alto

Metodi

  Nome Descrizione
Metodo pubblico Add(ScriptOption) Adds a ScriptOption object to the ScriptingOptions object.
Metodo pubblicoMembro statico Add(ScriptingOptions, ScriptOption) Adds the specified ScriptOption and ScriptingOptions objects to the ScriptingOptions.
Metodo pubblicoMembro statico ConvertVersion Converts the server version to a SqlServerVersion value.
Metodo pubblico Equals Ereditato da Object.
Metodo protetto Finalize Ereditato da Object.
Metodo pubblico GetHashCode Ereditato da Object.
Metodo pubblico GetType Ereditato da Object.
Metodo protetto MemberwiseClone Ereditato da Object.
Metodo pubblico Remove Removes a ScriptOption object from the ScriptingOptions object.
Metodo pubblico SetTargetDatabaseEngineType Sets the database engine type as specified in a DatabaseEngineType object.
Metodo pubblico SetTargetServerVersion Sets the version of the instance of SQL Server on which the scripting operation is run.
Metodo pubblicoMembro statico Subtract Subtracts the specified ScriptOption value from the specified ScriptingOptions object.
Metodo pubblico ToString Returns a string that represents the ScriptingOptions object. Esegue l'override di Object. . :: . .ToString() () () ().

In alto

Operatori

  Nome Descrizione
Operatore pubblicoMembro statico Addition Creates a set of scripting options by performing an addition operation on a ScriptingOptions object and a ScriptOption object.
Operatore pubblicoMembro statico Subtraction Creates a set of scripting options by performing an subtraction operation on a ScriptingOptions object and a ScriptOption object.

In alto

Osservazioni

Nota di attenzioneAttenzione

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

Thread Safety

Tutti i membri statici pubblici (Shared in Microsoft Visual Basic) di questo tipo sono sicuri per le operazioni a thread multipli. Non è invece garantita la sicurezza dei membri dell'istanza.

Esempi

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")
'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("AdventureWorks2008R2")
$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
      }
   }
}

Protezione dei thread

I membri static (Shared in Visual Basic) pubblici di questo tipo sono affidabili. Non è invece garantita la sicurezza dei membri dell'istanza.