Export (0) Print
Expand All

Scripter Class

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

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)

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

The Scripter type exposes the following members.

  NameDescription
Public methodScripterInitializes a new instance of the Scripter class.
Public methodScripter(Server)Initializes a new instance of the Scripter class on the specified instance of SQL Server.
Top

  NameDescription
Protected propertyDependencyTreeGets or sets a server dependency tree. (Inherited from DependencyWalker.)
Public propertyFilterCallbackFunctionGets or sets the scripting options that allow URNs to be filtered out while running the DiscoverDependencies method. (Inherited from DependencyWalker.)
Protected propertyKnownObjectsListGets or sets a list of all known objects in a server. (Inherited from DependencyWalker.)
Public propertyOptionsGets or sets the scripting options for the Scripter object and all the scripting operations on the instance of SQL Server.
Public propertyPrefetchObjectsGets or sets the Boolean property value that specifies whether the objects are loaded before scripting operations, or only as they are required.
Public propertyServerGets or sets the instance of Microsoft SQL Server that the DependencyWalker tool object is associated with. (Inherited from DependencyWalker.)
Protected propertyTotalGets or sets the number of objects that have been processed by the DependencyWalker object. (Inherited from DependencyWalker.)
Protected propertyTotalCountGets or sets the count of objects discovered by a dependency walker. (Inherited from DependencyWalker.)
Top

  NameDescription
Public methodDiscoverDependencies(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.)
Public methodDiscoverDependencies(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.)
Public methodDiscoverDependencies(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.)
Public methodDiscoverDependencies(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.)
Public methodDiscoverDependencies(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.)
Public methodDiscoverDependencies(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.)
Public methodStatic memberEnumDependenciesReturns an enumerated list that includes the specified object and child or parent dependencies.
Public methodEnumScript(SqlSmoObject())Returns an IEnumerable<script> object that contains a script.
Public methodEnumScript(Urn())Returns an IEnumerable <script> interface.
Public methodEnumScript(UrnCollection)Returns an IEnumerable <script> interface.
Public methodEnumScriptWithList(DependencyCollection)Creates a linear Transact-SQL script based on a dependency collection.
Public methodEnumScriptWithList(SqlSmoObject())Creates a linear Transact-SQL script based on an array of SqlSmoObjects.
Public methodEnumScriptWithList(Urn())Creates a linear Transact-SQL script that is based on an array of URNs.
Public methodEnumScriptWithList(UrnCollection)Creates a linear Transact-SQL script based on a URN collection.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetServerObjectReturns the Server object that represents the instance of SQL Server on which the dependency discovery operation is running. (Inherited from DependencyWalker.)
Public methodGetType (Inherited from Object.)
Protected methodInitInitializes the Scripter object.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodScript(SqlSmoObject())Generates Transact-SQL scripts that can be used to re-create a list of objects.
Public methodScript(Urn())Creates a Transact-SQL script for a set of objects that are specified with an array of Urn objects.
Public methodScript(UrnCollection)Creates a Transact-SQL script for a set of objects that are specified with a Urn object collection.
Public methodScriptWithList(DependencyCollection)Creates linear Transact-SQL scripts for a DependencyCollection object. 
Public methodScriptWithList(SqlSmoObject())Creates linear Transact-SQL scripts for an array of SqlSmoObject objects. 
Public methodScriptWithList(Urn())Creates linear Transact-SQL scripts for an array of Urn objects. 
Public methodScriptWithList(UrnCollection)Creates linear Transact-SQL scripts for a UrnCollection object. 
Public methodToString (Inherited from Object.)
Public methodWalkDependenciesCreates a linear list of objects and their dependencies from a specified DependencyTree object. (Inherited from DependencyWalker.)
Top

  NameDescription
Public eventDiscoveryProgressRaises an event at intervals and reports progress on the DiscoveryProgress method. (Inherited from DependencyWalker.)
Public eventScriptingErrorRaises an event when an error occurs during a scripting operation.
Public eventScriptingProgressRaises an event to receive information about the progress of the scripting operation.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft