Schema Class

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

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

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

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

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("CREATE_SCHEMA", "SCHEMA")>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "SCHEMA")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "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
	Schema()	Initializes a new instance of the Schema class.
	Schema(Database, String)	Initializes a new instance of the Schema class on the specified database and with the specified name.

Top

Properties

	Name	Description
	Events	Gets the events that are supported by the schema.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	ExtendedProperties	Represents a collection of ExtendedProperty objects that contain information about the extended properties of the Schema object.
	ID	Gets the ID value that uniquely identifies the schema.
	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.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	Name	Gets or sets a String value that specifies the name of the schema. (Overrides NamedSmoObject.Name.)
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Owner	Gets the owner of the schema.
	Parent	Gets the Database object that is the parent of the Schema object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	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.)

Top

Methods

	Name	Description
	AddDatabaseContext	Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
	Alter	Updates any Schema object property changes on instance of Microsoft SQL Server.
	AlterImpl	Activates the object altered event. (Inherited from SqlSmoObject.)
	AlterImplWorker	Calls the Alter methods. (Inherited from SqlSmoObject.)
	AppendCommaText	Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AppendWithCommaText	Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AppendWithOption	Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AutoGenerateName	Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
	BindDefaultImpl	Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
	BindRuleImpl	Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
	CheckObjectDirty	Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from SqlSmoObject.)
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
	CheckObjectStateImpl	Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
	CheckTextCorectness	Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
	CheckTextModeSupport	Checks mode of support. (Inherited from ScriptNameObjectBase.)
	CheckVersion100	Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
	CheckVersion110()	Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
	CheckVersion110(String)	Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.)
	CheckVersion80	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow110	Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
	CheckVersionBelow90	Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
	CleanObject	Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
	Create	Creates a schema on the instance of SQL Server as defined by the Schema object.
	CreateImpl	Creates an object with scripting options. (Inherited from SqlSmoObject.)
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the schema.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the schema.
	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.
	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.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the schema from the instance of SQL Server.
	DropImpl	Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
	DropImplWorker	Calls the drop methods. (Inherited from SqlSmoObject.)
	EnumObjectPermissions()	Enumerates a list of object permissions for the schema.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the schema.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the schema.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the schema.
	EnumOwnedObjects	Enumerates a list of objects that are owned by the schema.
	Equals	(Inherited from Object.)
	ExecuteNonQuery	Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
	ExecuteRenameQuery	Executes the rename query for the object. (Inherited from NamedSmoObject.)
	Finalize	(Inherited from Object.)
	ForceTextModeOnTextBody	Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GenerateAlterEvent()	Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
	GenerateAlterEvent(Urn, Object)	Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.)
	GetBraketNameForText	Gets the bracket name for the text. (Inherited from ScriptNameObjectBase.)
	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.)
	GetFragOptionString	Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetIsSystemNamed	Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
	GetIsTextDirty	Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetRealValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetTextBody()	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextBody(Boolean)	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextHeader	Returns the text header. (Inherited from ScriptNameObjectBase.)
	GetTextMode	Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
	GetTextProperty	Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (Inherited from ScriptNameObjectBase.)
	GetType	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the schema.
	Grant(ObjectPermissionSet, array<String[])	Grants access to the specified permission for the specified grantees on the schema.
	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.
	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.
	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.
	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.
	ImplInitialize	Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	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.)
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
	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.)
	IsVersion80SP3	Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
	IsVersion90AndAbove	Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
	MarkDropped	Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
	MarkForDropImpl	Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
	MemberwiseClone	(Inherited from Object.)
	PostAlter	The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
	PostCreate	The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
	PostDrop	The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	RenameImpl	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	RenameImplWorker	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the schema.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the schema.
	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.
	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.
	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.
	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.
	Script()	Generates a Transact-SQL script that can be used to re-create the schema.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the schema as specified by the script options.
	ScriptImpl()	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	SetCollectionTextMode	Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
	SetIsSystemNamed	Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetSchemaOwned	Sets the schema owned value. (Inherited from NamedSmoObject.)
	SetTextBody	Specifies the text body. (Inherited from ScriptNameObjectBase.)
	SetTextHeader	Specifies the text header. (Inherited from ScriptNameObjectBase.)
	SetTextMode	Specifies the text mode. (Inherited from ScriptNameObjectBase.)
	SwitchTextMode	Switches the text mode. (Inherited from ScriptNameObjectBase.)
	ThrowIfTextIsDirtyForAlter	Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl	Not implemented. (Inherited from SqlSmoObject.)
	UnbindDefaultImpl	Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
	UnbindRuleImpl	Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Fields

	Name	Description
	m_ExtendedProperties	Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
	singletonParent	Represents the singleton parent. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	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	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	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	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	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