Scripter Scripter Scripter Class

Definition

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

public ref class Scripter : Microsoft::SqlServer::Management::Smo::DependencyWalker
public class Scripter : Microsoft.SqlServer.Management.Smo.DependencyWalker
Public Class Scripter
Inherits DependencyWalker
Inheritance

Examples

Scripting

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.

Constructors

Scripter() Scripter() Scripter()

Initializes a new instance of the Scripter class.

Scripter(Server) Scripter(Server) Scripter(Server)

Initializes a new instance of the Scripter class on the specified instance of SQL Server.

Properties

DependencyTree DependencyTree DependencyTree

Gets or sets a server dependency tree.

(Inherited from DependencyWalker)
FilterCallbackFunction FilterCallbackFunction FilterCallbackFunction

Gets or sets the scripting options that allow URNs to be filtered out while running the DiscoverDependencies method.

(Inherited from DependencyWalker)
KnownObjectsList KnownObjectsList KnownObjectsList

Gets or sets a list of all known objects in a server.

(Inherited from DependencyWalker)
Options Options Options

Gets or sets the scripting options for the Scripter object and all the scripting operations on the instance of SQL Server.

PrefetchObjects PrefetchObjects 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 Server Server

Gets or sets the instance of Microsoft SQL Server that the DependencyWalker tool object is associated with.

(Inherited from DependencyWalker)
Total Total Total

Gets or sets the number of objects that have been processed by the DependencyWalker object.

(Inherited from DependencyWalker)
TotalCount TotalCount TotalCount

Gets or sets the count of objects discovered by a dependency walker.

(Inherited from DependencyWalker)

Methods

DiscoverDependencies(SqlSmoObject[], Boolean) DiscoverDependencies(SqlSmoObject[], Boolean) DiscoverDependencies(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(SqlSmoObject[], DependencyType) DiscoverDependencies(SqlSmoObject[], DependencyType) DiscoverDependencies(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(UrnCollection, Boolean) DiscoverDependencies(UrnCollection, Boolean) DiscoverDependencies(UrnCollection, Boolean)

Creates a hierarchical object tree that represents the parent or child dependent relationships for a specified UrnCollection of SQL Server objects on the instance of SQL Server.

(Inherited from DependencyWalker)
DiscoverDependencies(UrnCollection, DependencyType) DiscoverDependencies(UrnCollection, DependencyType) DiscoverDependencies(UrnCollection, DependencyType)

Creates a hierarchical object tree that represents the parent or child dependent relationships for a specified UrnCollection of SQL Server objects on the instance of SQL Server.

(Inherited from DependencyWalker)
DiscoverDependencies(Urn[], Boolean) DiscoverDependencies(Urn[], Boolean) DiscoverDependencies(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(Urn[], DependencyType) DiscoverDependencies(Urn[], DependencyType) DiscoverDependencies(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)
EnumDependencies(SqlSmoObject, DependencyType) EnumDependencies(SqlSmoObject, DependencyType) EnumDependencies(SqlSmoObject, DependencyType)

Returns an enumerated list that includes the specified object and child or parent dependencies.

EnumScript(SqlSmoObject[]) EnumScript(SqlSmoObject[]) EnumScript(SqlSmoObject[])

Returns an IEnumerable<script> object that contains a script.

EnumScript(UrnCollection) EnumScript(UrnCollection) EnumScript(UrnCollection)

Returns an IEnumerable <script> interface.

EnumScript(Urn[]) EnumScript(Urn[]) EnumScript(Urn[])

Returns an IEnumerable <script> interface.

EnumScriptWithList(DependencyCollection) EnumScriptWithList(DependencyCollection) EnumScriptWithList(DependencyCollection)

Creates a linear Transact-SQL script based on a dependency collection.

EnumScriptWithList(SqlSmoObject[]) EnumScriptWithList(SqlSmoObject[]) EnumScriptWithList(SqlSmoObject[])

Creates a linear Transact-SQL script based on an array of SqlSmoObjects.

EnumScriptWithList(UrnCollection) EnumScriptWithList(UrnCollection) EnumScriptWithList(UrnCollection)

Creates a linear Transact-SQL script based on a URN collection.

EnumScriptWithList(Urn[]) EnumScriptWithList(Urn[]) EnumScriptWithList(Urn[])

Creates a linear Transact-SQL script that is based on an array of URNs.

GetServerObject() GetServerObject() GetServerObject()

Returns the Server object that represents the instance of SQL Server on which the dependency discovery operation is running.

(Inherited from DependencyWalker)
Init() Init() Init()

Initializes the Scripter object.

Script(SqlSmoObject[]) Script(SqlSmoObject[]) Script(SqlSmoObject[])

Generates Transact-SQL scripts that can be used to re-create a list of objects.

Script(UrnCollection) Script(UrnCollection) Script(UrnCollection)

Creates a Transact-SQL script for a set of objects that are specified with a Urn object collection.

Script(Urn[]) Script(Urn[]) Script(Urn[])

Creates a Transact-SQL script for a set of objects that are specified with an array of Urn objects.

ScriptWithList(DependencyCollection) ScriptWithList(DependencyCollection) ScriptWithList(DependencyCollection)

Creates linear Transact-SQL scripts for a DependencyCollection object.

ScriptWithList(SqlSmoObject[]) ScriptWithList(SqlSmoObject[]) ScriptWithList(SqlSmoObject[])

Creates linear Transact-SQL scripts for an array of SqlSmoObject objects.

ScriptWithList(UrnCollection) ScriptWithList(UrnCollection) ScriptWithList(UrnCollection)

Creates linear Transact-SQL scripts for a UrnCollection object.

ScriptWithList(Urn[]) ScriptWithList(Urn[]) ScriptWithList(Urn[])

Creates linear Transact-SQL scripts for an array of Urn objects.

WalkDependencies(DependencyTree) WalkDependencies(DependencyTree) WalkDependencies(DependencyTree)

Creates a linear list of objects and their dependencies from a specified DependencyTree object.

(Inherited from DependencyWalker)

Events

DiscoveryProgress DiscoveryProgress DiscoveryProgress

Raises an event at intervals and reports progress on the DiscoveryProgress method.

(Inherited from DependencyWalker)
ScriptingError ScriptingError ScriptingError

Raises an event when an error occurs during a scripting operation.

ScriptingProgress ScriptingProgress ScriptingProgress

Raises an event to receive information about the progress of the scripting operation.

Applies to