Scripter Class

The Scripter object is the overall, top-level object for managing scripting operations.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.DependencyWalker
    Microsoft.SqlServer.Management.Smo.Scripter

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

Syntax

'Declaration
Public Class Scripter _
    Inherits DependencyWalker
'Usage
Dim instance As Scripter

public class Scripter : DependencyWalker

public ref class Scripter : public DependencyWalker

type Scripter =  
    class
        inherit DependencyWalker
    end

public class Scripter extends DependencyWalker

The Scripter type exposes the following members.

Constructors

	Name	Description
	Scripter()	Initializes a new instance of the Scripter class.
	Scripter(Server)	Initializes a new instance of the Scripter class on the specified instance of SQL Server.

Top

Properties

	Name	Description
	DependencyTree	Gets or sets a server Dependency Tree. (Inherited from DependencyWalker.)
	FilterCallbackFunction	Gets or sets the scripting options that allow URNs to be filtered out while running the DiscoverDependencies method. (Inherited from DependencyWalker.)
	KnownObjectsList	Gets or sets a list of all known objects in a server. (Inherited from DependencyWalker.)
	Options	Gets or sets the scripting options for the Scripter object and all the scripting operations on the instance of SQL Server.
	PrefetchObjects	Gets or sets the Boolean property value that specifies whether the objects are loaded before scripting operations, or only as they are required.
	Server	Gets or sets the instance of Microsoft SQL Server that the DependencyWalker tool object is associated with. (Inherited from DependencyWalker.)
	Total	Gets or sets the number of objects that have been processed by the DependencyWalker() object. (Inherited from DependencyWalker.)
	TotalCount	Gets or set the count of objects discovered by a Dependency Walker. (Inherited from DependencyWalker.)

Top

Methods

	Name	Description
	DiscoverDependencies(array<SqlSmoObject[], DependencyType)	Creates a hierarchical object tree that represents the parent or child dependent relationships for a specified object array of SQL Server objects on the instance of SQL Server. (Inherited from DependencyWalker.)
	DiscoverDependencies(array<SqlSmoObject[], Boolean)	Creates a hierarchical object tree that represents the parent or child dependent relationships for a specified object array of SQL Server objects on the instance of SQL Server. (Inherited from DependencyWalker.)
	DiscoverDependencies(array<Urn[], DependencyType)	Creates a hierarchical object tree that represents the parent- or child-dependent relationships for a specified Urn array of SQL Server objects on the instance of SQL Server. (Inherited from DependencyWalker.)
	DiscoverDependencies(array<Urn[], Boolean)	Creates a hierarchical object tree that represents the parent- or child-dependent relationships for a specified Urn array of SQL Server objects on the instance of SQL Server. (Inherited from DependencyWalker.)
	DiscoverDependencies(UrnCollection, DependencyType)	Creates a hierarchical object tree that represents the parent or child dependent relationships for a specified Urn collection of SQL Server objects on the instance of SQL Server. (Inherited from DependencyWalker.)
	DiscoverDependencies(UrnCollection, Boolean)	Creates a hierarchical object tree that represents the parent or child dependent relationships for a specified Urn collection of SQL Server objects on the instance of SQL Server. (Inherited from DependencyWalker.)
	EnumDependencies	Returns an enumerated list that includes the specified object and child or parent dependencies.
	EnumScript(array<SqlSmoObject[])	Returns an IEnumerable<script> object that contains a script.
	EnumScript(array<Urn[])	Returns an IEnumerable <script> interface.
	EnumScript(UrnCollection)	Returns an IEnumerable <script> interface.
	EnumScriptWithList(DependencyCollection)	Creates a linear Transact-SQL script based on a dependency collection.
	EnumScriptWithList(array<SqlSmoObject[])	Creates a linear Transact-SQL script based on an array of SqlSmoObjects.
	EnumScriptWithList(array<Urn[])	Creates a linear Transact-SQL script that is based on an array of URNs.
	EnumScriptWithList(UrnCollection)	Creates a linear Transact-SQL script based on a URN collection.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetServerObject	Returns the Server object that represents the instance of SQL Server on which the dependency discovery operation is running. (Inherited from DependencyWalker.)
	GetType	(Inherited from Object.)
	Init	Initializes the Scripter object.
	MemberwiseClone	(Inherited from Object.)
	Script(array<SqlSmoObject[])	Generates Transact-SQL scripts that can be used to re-create a list of objects.
	Script(array<Urn[])	Creates a Transact-SQL script for a set of objects that are specified with an array of Urn objects.
	Script(UrnCollection)	Creates a Transact-SQL script for a set of objects that are specified with a Urn object collection.
	ScriptWithList(DependencyCollection)	Creates linear Transact-SQL scripts for a DependencyCollection object.
	ScriptWithList(array<SqlSmoObject[])	Creates linear Transact-SQL scripts for an array of SqlSmoObject objects.
	ScriptWithList(array<Urn[])	Creates linear Transact-SQL scripts for an array of Urn objects.
	ScriptWithList(UrnCollection)	Creates linear Transact-SQL scripts for a UrnCollection object.
	ToString	(Inherited from Object.)
	WalkDependencies	Creates a linear list of objects and their dependencies from a specified DependencyTree object. (Inherited from DependencyWalker.)

Top

Events

	Name	Description
	DiscoveryProgress	Raises an event at intervals and reports progress on the DiscoveryProgress method. (Inherited from DependencyWalker.)
	ScriptingError	Raises an event when an error occurs during a scripting operation.
	ScriptingProgress	Raises an event to receive information about the progress of the scripting operation.

Top

Remarks

The Scripter object allows programmatic access to scripting settings and is responsible for the following scripting functionality:

• Finding dependencies.

• Output script to memory and file.

• Calling the instance objects to be scripted.

• Managing context of a script operation, such as checking whether an object has already been scripted.

To get Scripter object properties, users can be a member of the public fixed server role.

To set Scripter object properties, users can be a member of the public fixed server role.

To run a script operation, users require permissions for the objects that are being scripted.

Thread Safety

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

Examples

Scripting

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace