Freigeben über


Scripter-Klasse

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

Vererbungshierarchie

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

Der Scripter-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode Scripter() Initializes a new instance of the Scripter class.
Öffentliche Methode Scripter(Server) Initializes a new instance of the Scripter class on the specified instance of SQL Server.

Zum Anfang

Eigenschaften

  Name Beschreibung
Geschützte Eigenschaft DependencyTree Gets or sets a server dependency tree. (Geerbt von DependencyWalker.)
Öffentliche Eigenschaft FilterCallbackFunction Gets or sets the scripting options that allow URNs to be filtered out while running the DiscoverDependencies method. (Geerbt von DependencyWalker.)
Geschützte Eigenschaft KnownObjectsList Gets or sets a list of all known objects in a server. (Geerbt von DependencyWalker.)
Öffentliche Eigenschaft Options Gets or sets the scripting options for the Scripter object and all the scripting operations on the instance of SQL Server.
Öffentliche Eigenschaft PrefetchObjects Gets or sets the Boolean property value that specifies whether the objects are loaded before scripting operations, or only as they are required.
Öffentliche Eigenschaft Server Gets or sets the instance of Microsoft SQL Server that the DependencyWalker tool object is associated with. (Geerbt von DependencyWalker.)
Geschützte Eigenschaft Total Gets or sets the number of objects that have been processed by the DependencyWalker object. (Geerbt von DependencyWalker.)
Geschützte Eigenschaft TotalCount Gets or sets the count of objects discovered by a dependency walker. (Geerbt von DependencyWalker.)

Zum Anfang

Methoden

  Name Beschreibung
Öffentliche Methode 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. (Geerbt von DependencyWalker.)
Öffentliche Methode 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. (Geerbt von DependencyWalker.)
Öffentliche Methode 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. (Geerbt von DependencyWalker.)
Öffentliche Methode 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. (Geerbt von DependencyWalker.)
Öffentliche Methode 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. (Geerbt von DependencyWalker.)
Öffentliche Methode 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. (Geerbt von DependencyWalker.)
Öffentliche MethodeStatisches Element EnumDependencies Returns an enumerated list that includes the specified object and child or parent dependencies.
Öffentliche Methode EnumScript(array<SqlSmoObject[]) Returns an IEnumerable<script> object that contains a script.
Öffentliche Methode EnumScript(array<Urn[]) Returns an IEnumerable <script> interface.
Öffentliche Methode EnumScript(UrnCollection) Returns an IEnumerable <script> interface.
Öffentliche Methode EnumScriptWithList(DependencyCollection) Creates a linear Transact-SQL script based on a dependency collection.
Öffentliche Methode EnumScriptWithList(array<SqlSmoObject[]) Creates a linear Transact-SQL script based on an array of SqlSmoObjects.
Öffentliche Methode EnumScriptWithList(array<Urn[]) Creates a linear Transact-SQL script that is based on an array of URNs.
Öffentliche Methode EnumScriptWithList(UrnCollection) Creates a linear Transact-SQL script based on a URN collection.
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode Finalize (Geerbt von Object.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Geschützte Methode GetServerObject Returns the Server object that represents the instance of SQL Server on which the dependency discovery operation is running. (Geerbt von DependencyWalker.)
Öffentliche Methode GetType (Geerbt von Object.)
Geschützte Methode Init Initializes the Scripter object.
Geschützte Methode MemberwiseClone (Geerbt von Object.)
Öffentliche Methode Script(array<SqlSmoObject[]) Generates Transact-SQL scripts that can be used to re-create a list of objects.
Öffentliche Methode Script(array<Urn[]) Creates a Transact-SQL script for a set of objects that are specified with an array of Urn objects.
Öffentliche Methode Script(UrnCollection) Creates a Transact-SQL script for a set of objects that are specified with a Urn object collection.
Öffentliche Methode ScriptWithList(DependencyCollection) Creates linear Transact-SQL scripts for a DependencyCollection object. 
Öffentliche Methode ScriptWithList(array<SqlSmoObject[]) Creates linear Transact-SQL scripts for an array of SqlSmoObject objects. 
Öffentliche Methode ScriptWithList(array<Urn[]) Creates linear Transact-SQL scripts for an array of Urn objects. 
Öffentliche Methode ScriptWithList(UrnCollection) Creates linear Transact-SQL scripts for a UrnCollection object. 
Öffentliche Methode ToString (Geerbt von Object.)
Öffentliche Methode WalkDependencies Creates a linear list of objects and their dependencies from a specified DependencyTree object. (Geerbt von DependencyWalker.)

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis DiscoveryProgress Raises an event at intervals and reports progress on the DiscoveryProgress method. (Geerbt von DependencyWalker.)
Öffentliches Ereignis ScriptingError Raises an event when an error occurs during a scripting operation.
Öffentliches Ereignis ScriptingProgress Raises an event to receive information about the progress of the scripting operation.

Zum Anfang

Hinweise

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

Alle öffentlichen, statischen Elemente dieses Typs (Shared in Microsoft Visual Basic) sind für Vorgänge mit mehreren Threads sicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Beispiele

Skripterstellung

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Management.Smo-Namespace