StoredProcedure Class

  • Article

The StoredProcedure object represents a SQL Server stored procedure.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.StoredProcedure

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

Syntax

'Declaration
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "PROCEDURE")> _
<StateChangeEventAttribute("CREATE_PROCEDURE", "PROCEDURE")> _
<StateChangeEventAttribute("RENAME", "PROCEDURE")> _
<StateChangeEventAttribute("ALTER_SCHEMA", "PROCEDURE")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
<StateChangeEventAttribute("ALTER_PROCEDURE", "PROCEDURE")> _
Public NotInheritable Class StoredProcedure _
    Inherits ScriptSchemaObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable,  _
    IDroppable, IRenamable, IExtendedProperties, IScriptable, ITextObject
'Usage
Dim instance As StoredProcedure

[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "PROCEDURE")]
[StateChangeEventAttribute("CREATE_PROCEDURE", "PROCEDURE")]
[StateChangeEventAttribute("RENAME", "PROCEDURE")]
[StateChangeEventAttribute("ALTER_SCHEMA", "PROCEDURE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
[StateChangeEventAttribute("ALTER_PROCEDURE", "PROCEDURE")]
public sealed class StoredProcedure : ScriptSchemaObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, 
    IRenamable, IExtendedProperties, IScriptable, ITextObject

[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"PROCEDURE")]
[StateChangeEventAttribute(L"CREATE_PROCEDURE", L"PROCEDURE")]
[StateChangeEventAttribute(L"RENAME", L"PROCEDURE")]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"PROCEDURE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[StateChangeEventAttribute(L"ALTER_PROCEDURE", L"PROCEDURE")]
public ref class StoredProcedure sealed : public ScriptSchemaObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, 
    IRenamable, IExtendedProperties, IScriptable, ITextObject

[<SealedAttribute>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "PROCEDURE")>]
[<StateChangeEventAttribute("CREATE_PROCEDURE", "PROCEDURE")>]
[<StateChangeEventAttribute("RENAME", "PROCEDURE")>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "PROCEDURE")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
[<StateChangeEventAttribute("ALTER_PROCEDURE", "PROCEDURE")>]
type StoredProcedure =  
    class 
        inherit ScriptSchemaObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ITextObject 
    end

public final class StoredProcedure extends ScriptSchemaObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, IScriptable, ITextObject

The StoredProcedure type exposes the following members.

Constructors

  Name Description
Public method StoredProcedure() Initializes a new instance of the StoredProcedure class.
Public method StoredProcedure(Database, String) Initializes a new instance of the StoredProcedure class on the specified database and with the specified name.
Public method StoredProcedure(Database, String, String) Initializes a new instance of the StoredProcedure class on the specified database and with the specified name and schema.

Top

Properties

  Name Description
Public property AnsiNullsStatus Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the stored procedure.
Public property AssemblyName Gets or sets the name of the .NET assembly that is required by the referenced stored procedure.
Public property ClassName Gets or sets the name of the class called by the referenced stored procedure.
Public property CreateDate Gets the date and time when the stored procedure was created.
Public property DateLastModified Gets the date and time when the stored procedure was last modified.
Public property Events Gets the events associated with the stored procedure.
Public property ExecutionContext Gets or sets the execution context for the stored procedure.
Public property ExecutionContextPrincipal Gets or sets the execution context principal for the stored procedure.
Public property ExtendedProperties Gets the extended properties of the StoredProcedure object.
Public property ForReplication Gets or sets the Boolean property value that specifies whether the stored procedure is available for replication.
Public property ID Gets the ID value that uniquely identifies the stored procedure.
Public property ImplementationType Gets or sets the implementation type of the stored procedure.
Public property IsEncrypted Gets or sets the Boolean property value that specifies whether the stored procedure is encrypted.
Public property IsSchemaOwned Gets a Boolean property that specifies whether the stored procedure is owned by a schema.
Public property IsSystemObject Gets the Boolean property value that specifies whether the stored procedure is a system object.
Public property MethodName Gets the method name for the stored procedure.
Public property Name Gets or sets a String value that specifies the name of the stored procedure. (Overrides ScriptSchemaObjectBase.Name.)
Public property NumberedStoredProcedures Represents a collection of NumberedStoredProcedureCollection objects. Each NumberedStoredProcedure object represents a numbered stored procedure defined for the stored procedure.
Public property Owner Gets or sets the owner of the stored procedure.
Public property Parameters Represents a collection of StoredProcedureParameterCollection objects. Each StoredProcedureParameter object represents a parameter defined for the stored procedure.
Public property Parent Gets or sets the Database object that is the parent of the StoredProcedure object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property QuotedIdentifierStatus Gets or sets a Boolean property value that specifies whether identifiers delimited by double quotation marks are Transact-SQL reserved keywords or contain characters not usually allowed by the Transact-SQL syntax rules.
Public property Recompile Gets or sets the Boolean property value that specifies whether the stored procedure is recompiled before execution.
Public property Schema Gets or sets a String value that specifies the name of the schema that contains the stored procedure. (Overrides ScriptSchemaObjectBase.Schema.)
Public property Startup Gets or sets the Boolean property value that specifies whether the stored procedure runs when the instance of Microsoft SQL Server starts up.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property TextBody Gets or sets the Transact-SQL string that defines the stored procedure.
Public property TextHeader Gets or sets the header part of the Transact-SQL string that defines the stored procedure.
Public property TextMode Gets or sets the Boolean property that specifies whether the text header is editable as text.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any StoredProcedure object property changes on the instance of Microsoft SQL Server. 
Public method ChangeSchema Changes the schema for the stored procedure.
Public method Create Creates a stored procedure on the instance of Microsoft SQL Server as defined by the StoredProcedure object.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the stored procedure.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the stored procedure.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the stored procedure.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the stored procedure.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the stored procedure from the instance of SQL Server.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the stored procedure.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the stored procedure.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the stored procedure.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the stored procedure.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the stored procedure.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the stored procedure.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants access to the specified permission to the grantee and the ability to grant access to other users on the stored procedure.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants access to the specified permission to the grantees and the ability to grant access to other users on the stored procedure.
Public method Grant(ObjectPermissionSet, String, Boolean, String) Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the stored procedure under an assumed role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the stored procedure under an assumed role.
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method ReCompileReferences Recompiles any stored procedure or trigger that depends on the base SMO object.
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Renames the stored procedure.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the stored procedure.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the stored procedure.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the stored procedure and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes previously granted permissions from grantees on the stored procedure and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes previously granted permissions from a grantee on the stored procedure and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes previously granted permissions from grantees on the stored procedure and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Script() Generates a Transact-SQL script that can be used to re-create the stored procedure.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the stored procedure as specified by the script options.
Public method ScriptHeader Returns the text header with the option to modify the text.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that specifies whether the stored procedure supports design mode.

Top

Remarks

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

To set StoredProcedure object properties, users must have ALTER permission on the stored procedure, or be a member of db_owner fixed database role.

To create a stored procedure, users must have CREATE PROCEDURE permission on the parent database or be a member of the db_owner fixed database role.

To drop a stored procedure, users must have CONTROL permission on the stored procedure or be a member of the db_owner fixed database role.

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

Creating, Altering, and Removing Stored Procedures

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

Other Resources

CREATE PROCEDURE (Transact-SQL)