Schema Class

  • Article

The Schema object represents an ownership context for a SQL Server database object.

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

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<StateChangeEventAttribute("ALTER_SCHEMA", "SCHEMA")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "SCHEMA")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<StateChangeEventAttribute("CREATE_SCHEMA", "SCHEMA")> _
Public NotInheritable Class Schema _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IExtendedProperties, IScriptable, IAlterable
'Usage
Dim instance As Schema

[PhysicalFacetAttribute]
[StateChangeEventAttribute("ALTER_SCHEMA", "SCHEMA")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "SCHEMA")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[StateChangeEventAttribute("CREATE_SCHEMA", "SCHEMA")]
public sealed class Schema : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, 
    IScriptable, IAlterable

[PhysicalFacetAttribute]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"SCHEMA")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"SCHEMA")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[StateChangeEventAttribute(L"CREATE_SCHEMA", L"SCHEMA")]
public ref class Schema sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, 
    IScriptable, IAlterable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "SCHEMA")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "SCHEMA")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<StateChangeEventAttribute("CREATE_SCHEMA", "SCHEMA")>]
type Schema =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IExtendedProperties 
        interface IScriptable 
        interface IAlterable 
    end

public final class Schema extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, IScriptable, IAlterable

The Schema type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Events Gets the events that are supported by the schema.
Public property ExtendedProperties Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Schema object.
Public property ID Gets the ID value that uniquely identifies the schema.
Public property IsSystemObject Gets a Boolean value that indicates whether the object is an Object. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Public property Name Gets or sets a String value that specifies the name of the schema. (Overrides NamedSmoObject.Name.)
Public property Owner Gets the owner of the schema.
Public property Parent Gets the Database object that is the parent of the Schema object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
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 Schema object property changes on instance of Microsoft SQL Server.
Public method Create Creates a schema on the instance of SQL Server as defined by the Schema object.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the schema.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the schema.
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 schema.
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 schema.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the schema from the instance of SQL Server.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the schema.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the schema.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the schema.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the schema.
Public method EnumOwnedObjects Enumerates a list of objects that are owned by the schema.
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 schema.
Public method Grant(ObjectPermissionSet, array<String[]) Grants access to the specified permission for the specified grantees on the schema.
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 schema.
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 schema.
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 schema 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 schema 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 Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the schema.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the schema.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the schema 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 schema 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 schema and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes previously granted permissions from grantees on the schema 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 schema.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the schema as specified by the script options.
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 schema supports design mode.

Top

Remarks

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

To set Schema object properties, users must have ALTER permission on the schema.

To create a schema, users must have CREATE SCHEMA permission on the database.

To drop a schema, users must have CONTROL permission on the schema.

To grant, deny, or revoke permissions to users on the schema, users must have CONTROL permission on the schema.

To transfer objects into the schema, users must have CONTROL permissions on the object and ALTER permissions on the schema.

Examples

Creating, Altering, and Removing Schemas

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 SCHEMA (Transact-SQL)

Understanding the Database Schemas