ScriptingOptions Class

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

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
<DefaultMemberAttribute("Item")> _
Public NotInheritable Class ScriptingOptions

[DefaultMemberAttribute("Item")] 
public sealed class ScriptingOptions

[DefaultMemberAttribute(L"Item")] 
public ref class ScriptingOptions sealed

/** @attribute DefaultMemberAttribute("Item") */ 
public final class ScriptingOptions

DefaultMemberAttribute("Item") 
public final class ScriptingOptions

Remarks

Updated text:

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

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Inheritance Hierarchy

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

Example

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

ScriptingOptions Members
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

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

Change History