StoredProcedure Class
The StoredProcedure object represents a SQL Server stored procedure.
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
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
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)] [StateChangeEventAttribute("CREATE_PROCEDURE", "PROCEDURE")] [StateChangeEventAttribute("ALTER_PROCEDURE", "PROCEDURE")] [StateChangeEventAttribute("RENAME", "PROCEDURE")] [StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "PROCEDURE")] [StateChangeEventAttribute("ALTER_SCHEMA", "PROCEDURE")] [EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None | AutomatedPolicyEvaluationMode::Enforce | AutomatedPolicyEvaluationMode::CheckOnChanges | AutomatedPolicyEvaluationMode::CheckOnSchedule)] public ref class StoredProcedure sealed : ScriptSchemaObjectBase, ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, IDroppable, IDropIfExists, IRenamable, IExtendedProperties, IScriptable, ITextObject
| Name | Description | |
|---|---|---|
![]() | StoredProcedure() | Initializes a new instance of the StoredProcedure class. |
![]() | StoredProcedure(Database^, String^) | Initializes a new instance of the StoredProcedure class on the specified database and with the specified name. |
![]() | StoredProcedure(Database^, String^, String^) | Initializes a new instance of the StoredProcedure class on the specified database and with the specified name and schema. |
| Name | Description | |
|---|---|---|
![]() | AnsiNullsStatus | Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the stored procedure. |
![]() | AssemblyName | Gets or sets the name of the .NET assembly that is required by the referenced stored procedure. |
![]() | ClassName | Gets or sets the name of the class called by the referenced stored procedure. |
![]() | CreateDate | Gets the date and time when the stored procedure was created. |
![]() | DateLastModified | Gets the date and time when the stored procedure was last modified. |
![]() | Events | Gets the events associated with the stored procedure. |
![]() | ExecutionContext | Gets or sets the execution context for the stored procedure. |
![]() | ExecutionContextPrincipal | Gets or sets the execution context principal for the stored procedure. |
![]() | ExecutionManager | Gets the object to execute to the manager.(Inherited from SqlSmoObject.) |
![]() | ExtendedProperties | Gets the extended properties of the StoredProcedure object. |
![]() | ForReplication | Gets or sets the Boolean property value that specifies whether the stored procedure is available for replication. |
![]() | ID | Gets the ID value that uniquely identifies the stored procedure. |
![]() | ImplementationType | Gets or sets the implementation type of the stored procedure. |
![]() | IsEncrypted | Gets or sets the Boolean property value that specifies whether the stored procedure is encrypted. |
![]() | IsNativelyCompiled | Gets or sets the Boolean property that specifies whether the stored procedure is natively compiled. |
![]() | IsSchemaBound | Gets or sets the Boolean property that specifies whether the stored procedure is bound to the schema of the database objects it references. |
![]() | IsSchemaOwned | Gets a Boolean property that specifies whether the stored procedure is owned by a schema. |
![]() | IsSystemObject | Gets the Boolean property value that specifies whether the stored procedure is a system object. |
![]() | MethodName | Gets the method name for the stored procedure. |
![]() | Name | Gets or sets a String value that specifies the name of the stored procedure.(Overrides ScriptSchemaObjectBase::Name.) |
![]() | NumberedStoredProcedures | Represents a collection of NumberedStoredProcedureCollection objects. Each NumberedStoredProcedure object represents a numbered stored procedure defined for the stored procedure. |
![]() | Owner | Gets or sets the owner of the stored procedure. |
![]() | Parameters | Represents a collection of StoredProcedureParameterCollection objects. Each StoredProcedureParameter object represents a parameter defined for the stored procedure. |
![]() | Parent | Gets or sets the Database object that is the parent of the StoredProcedure object. |
![]() | Properties | Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.) |
![]() | 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. |
![]() | Recompile | Gets or sets the Boolean property value that specifies whether the stored procedure is recompiled before execution. |
![]() | Schema | Gets or sets a String value that specifies the name of the schema that contains the stored procedure.(Overrides ScriptSchemaObjectBase::Schema.) |
![]() | Startup | Gets or sets the Boolean property value that specifies whether the stored procedure runs when the instance of Microsoft SQL Server starts up. |
![]() | State | Gets the state of the referenced object.(Inherited from SmoObjectBase.) |
![]() | TextBody | Gets or sets the Transact-SQL string that defines the stored procedure. |
![]() | TextHeader | Gets or sets the header part of the Transact-SQL string that defines the stored procedure. |
![]() | TextMode | Gets or sets the Boolean property that specifies whether the text header is editable as text. |
![]() | Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.) |
![]() | UserData | Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.) |
| Name | Description | |
|---|---|---|
![]() | Alter() | Updates any StoredProcedure object property changes on the instance of Microsoft SQL Server. |
![]() | ChangeSchema(String^) | Changes the schema for the stored procedure. |
![]() | Create() | Creates a stored procedure on the instance of Microsoft SQL Server as defined by the StoredProcedure object. |
![]() | Deny(ObjectPermissionSet^, String^) | Denies the specified set of permissions for the specified grantee on the stored procedure. |
![]() | 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. |
![]() | Deny(ObjectPermissionSet^, array<String^>^) | Denies the specified set of permissions for the specified grantees on the stored procedure. |
![]() | 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. |
![]() | Discover() | Discovers a list of type Object.(Inherited from SqlSmoObject.) |
![]() | Drop() | Removes the stored procedure from the instance of SQL Server. |
![]() | DropIfExists() | Drops the StoredProcedure object if exists. |
![]() | EnumObjectPermissions() | Enumerates a list of object permissions for the stored procedure. |
![]() | EnumObjectPermissions(ObjectPermissionSet^) | Enumerates a list of object permissions for a specified permission on the stored procedure. |
![]() | EnumObjectPermissions(String^) | Enumerates a list of object permissions for a specified grantee on the stored procedure. |
![]() | EnumObjectPermissions(String^, ObjectPermissionSet^) | Enumerates a list of object permissions for a specified grantee and a specified permission on the stored procedure. |
![]() | Equals(Object^) | (Inherited from Object.) |
![]() | FormatSqlVariant(Object^) | Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.) |
![]() | GetContextDB() | Gets the context database that is associated with this object.(Inherited from SqlSmoObject.) |
![]() | GetDBName() | Gets the database name that is associated with the object.(Inherited from SqlSmoObject.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetPropValue(String^) | Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.) |
![]() | GetPropValueOptional(String^) | Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.) |
![]() | GetPropValueOptionalAllowNull(String^) | Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.) |
![]() | GetServerObject() | Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.) |
![]() | GetType() | (Inherited from Object.) |
![]() | Grant(ObjectPermissionSet^, String^) | Grants the specified set of permissions to the specified grantee on the stored procedure. |
![]() | 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. |
![]() | 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. |
![]() | Grant(ObjectPermissionSet^, array<String^>^) | Grants the specified set of permissions to the specified grantees on the stored procedure. |
![]() | 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. |
![]() | 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. |
![]() | Initialize() | Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.) |
![]() | Initialize(Boolean) | Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.) |
![]() | IsObjectInitialized() | Verifies whether the object has been initialized.(Inherited from SqlSmoObject.) |
![]() | IsObjectInSpace() | Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.) |
![]() | IsSupportedProperty(String^) | Determines whether the specified property is supported in the target .NET Framework.(Inherited from SqlSmoObject.) |
![]() | ReCompileReferences() | Recompiles any stored procedure or trigger that depends on the base SMO object. |
![]() | Refresh() | Refreshes the script name.(Inherited from ScriptNameObjectBase.) |
![]() | Rename(String^) | Renames the stored procedure. |
![]() | Revoke(ObjectPermissionSet^, String^) | Revokes a previously granted set of permissions from a grantee on the stored procedure. |
![]() | 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. |
![]() | 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. |
![]() | Revoke(ObjectPermissionSet^, array<String^>^) | Revokes a previously granted set of permissions from a list of grantees on the stored procedure. |
![]() | 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. |
![]() | 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. |
![]() | Script() | Generates a Transact-SQL script that can be used to re-create the stored procedure. |
![]() | Script(ScriptingOptions^) | Generates a Transact-SQL script that can be used to re-create the stored procedure as specified by the script options. |
![]() | ScriptHeader(Boolean) | Returns the text header with the option to modify the text. |
![]() | SetParentImpl(SqlSmoObject^) | Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.) |
![]() | ToString() | Returns a String that represents the referenced object.(Inherited from SqlSmoObject.) |
![]() | Validate(String^, array<Object^>^) | Validates the state of an object.(Inherited from SmoObjectBase.) |
| Name | Description | |
|---|---|---|
![]() | PropertyChanged | Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.) |
![]() | PropertyMetadataChanged | Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IAlienObject::Discover() | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.) |
![]() ![]() | IAlienObject::GetDomainRoot() | Returns the root of the domain.(Inherited from SqlSmoObject.) |
![]() ![]() | 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.) |
![]() ![]() | IAlienObject::GetPropertyType(String^) | Gets the type of the specified property.(Inherited from SqlSmoObject.) |
![]() ![]() | IAlienObject::GetPropertyValue(String^, Type^) | Gets the value of the specified property.(Inherited from SqlSmoObject.) |
![]() ![]() | 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.) |
![]() ![]() | IAlienObject::Resolve(String^) | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.) |
![]() ![]() | IAlienObject::SetObjectState(SfcObjectState) | Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.) |
![]() ![]() | IAlienObject::SetPropertyValue(String^, Type^, Object^) | Sets the property value.(Inherited from SqlSmoObject.) |
![]() ![]() | ISfcPropertyProvider::GetPropertySet() | Gets the interface reference to the set of properties of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.) |
![]() ![]() | ISfcSupportsDesignMode::IsDesignMode | Gets a value that indicates whether the stored procedure supports design mode. |
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.
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.






