Classe Scripter

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

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
Public Class Scripter _
    Inherits DependencyWalker
'Utilisation
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

Le type Scripter expose les membres suivants.

Constructeurs

	Nom	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.

Haut de la page

Propriétés

	Nom	Description
	DependencyTree	Gets or sets a server Dependency Tree. (hérité de DependencyWalker.)
	FilterCallbackFunction	Gets or sets the scripting options that allow URNs to be filtered out while running the DiscoverDependencies method. (hérité de DependencyWalker.)
	KnownObjectsList	Gets or sets a list of all known objects in a server. (hérité de 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. (hérité de DependencyWalker.)
	Total	Gets or sets the number of objects that have been processed by the DependencyWalker()()()() object. (hérité de DependencyWalker.)
	TotalCount	Gets or set the count of objects discovered by a Dependency Walker. (hérité de DependencyWalker.)

Haut de la page

Méthodes

	Nom	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. (hérité de 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. (hérité de 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. (hérité de 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. (hérité de 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. (hérité de 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. (hérité de 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	(hérité de Object.)
	Finalize	(hérité de Object.)
	GetHashCode	(hérité de Object.)
	GetServerObject	Returns the Server object that represents the instance of SQL Server on which the dependency discovery operation is running. (hérité de DependencyWalker.)
	GetType	(hérité de Object.)
	Init	Initializes the Scripter object.
	MemberwiseClone	(hérité de 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	(hérité de Object.)
	WalkDependencies	Creates a linear list of objects and their dependencies from a specified DependencyTree object. (hérité de DependencyWalker.)

Haut de la page

Événements

	Nom	Description
	DiscoveryProgress	Raises an event at intervals and reports progress on the DiscoveryProgress method. (hérité de 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.

Haut de la page

Notes

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

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Exemples

Création de scripts

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Smo