Export (0) Print
Expand All

StoredProcedure Class

The StoredProcedure object represents a SQL Server stored procedure.

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

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

The StoredProcedure type exposes the following members.

  NameDescription
Public methodStoredProcedure()Initializes a new instance of the StoredProcedure class.
Public methodStoredProcedure(Database, String)Initializes a new instance of the StoredProcedure class on the specified database and with the specified name.
Public methodStoredProcedure(Database, String, String)Initializes a new instance of the StoredProcedure class on the specified database and with the specified name and schema.
Top

  NameDescription
Public propertyAnsiNullsStatusGets the Boolean property value that specifies whether ISO NULL handling is enabled in the stored procedure.
Public propertyAssemblyNameGets or sets the name of the .NET assembly that is required by the referenced stored procedure.
Public propertyClassNameGets or sets the name of the class called by the referenced stored procedure.
Public propertyCreateDateGets the date and time when the stored procedure was created.
Public propertyDateLastModifiedGets the date and time when the stored procedure was last modified.
Public propertyEventsGets the events associated with the stored procedure.
Public propertyExecutionContextGets or sets the execution context for the stored procedure.
Public propertyExecutionContextPrincipalGets or sets the execution context principal for the stored procedure.
Public propertyExtendedPropertiesGets the extended properties of the StoredProcedure object.
Public propertyForReplicationGets or sets the Boolean property value that specifies whether the stored procedure is available for replication.
Public propertyIDGets the ID value that uniquely identifies the stored procedure.
Public propertyImplementationTypeGets or sets the implementation type of the stored procedure.
Public propertyIsEncryptedGets or sets the Boolean property value that specifies whether the stored procedure is encrypted.
Public propertyIsNativelyCompiledGets or sets the Boolean property that specifies whether the stored procedure is natively compiled.
Public propertyIsSchemaBoundGets or sets the Boolean property that specifies whether the stored procedure is bound to the schema of the database objects it references.
Public propertyIsSchemaOwnedGets a Boolean property that specifies whether the stored procedure is owned by a schema.
Public propertyIsSystemObjectGets the Boolean property value that specifies whether the stored procedure is a system object.
Public propertyMethodNameGets the method name for the stored procedure.
Public propertyNameGets or sets a String value that specifies the name of the stored procedure. (Overrides ScriptSchemaObjectBase.Name.)
Public propertyNumberedStoredProceduresRepresents a collection of NumberedStoredProcedureCollection objects. Each NumberedStoredProcedure object represents a numbered stored procedure defined for the stored procedure.
Public propertyOwnerGets or sets the owner of the stored procedure.
Public propertyParametersRepresents a collection of StoredProcedureParameterCollection objects. Each StoredProcedureParameter object represents a parameter defined for the stored procedure.
Public propertyParentGets or sets the Database object that is the parent of the StoredProcedure object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyQuotedIdentifierStatusGets 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 propertyRecompileGets or sets the Boolean property value that specifies whether the stored procedure is recompiled before execution.
Public propertySchemaGets or sets a String value that specifies the name of the schema that contains the stored procedure. (Overrides ScriptSchemaObjectBase.Schema.)
Public propertyStartupGets or sets the Boolean property value that specifies whether the stored procedure runs when the instance of Microsoft SQL Server starts up.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyTextBodyGets or sets the Transact-SQL string that defines the stored procedure.
Public propertyTextHeaderGets or sets the header part of the Transact-SQL string that defines the stored procedure.
Public propertyTextModeGets or sets the Boolean property that specifies whether the text header is editable as text.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any StoredProcedure object property changes on the instance of Microsoft SQL Server. 
Public methodChangeSchemaChanges the schema for the stored procedure.
Public methodCreateCreates a stored procedure on the instance of Microsoft SQL Server as defined by the StoredProcedure object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the stored procedure.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the stored procedure.
Public methodDeny(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 methodDeny(ObjectPermissionSet, 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 methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the stored procedure from the instance of SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the stored procedure.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the stored procedure.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the stored procedure.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the stored procedure.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the stored procedure.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the stored procedure.
Public methodGrant(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 methodGrant(ObjectPermissionSet, 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 methodGrant(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 methodGrant(ObjectPermissionSet, 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 methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodReCompileReferencesRecompiles any stored procedure or trigger that depends on the base SMO object.
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRenameRenames the stored procedure.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the stored procedure.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a list of grantees on the stored procedure.
Public methodRevoke(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 methodRevoke(ObjectPermissionSet, 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 methodRevoke(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 methodRevoke(ObjectPermissionSet, 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 methodScript()Generates a Transact-SQL script that can be used to re-create the stored procedure.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the stored procedure as specified by the script options.
Public methodScriptHeaderReturns the text header with the option to modify the text.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets a Boolean value that specifies whether the stored procedure supports design mode.
Top

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.

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