PartitionScheme Class

The PartitionScheme object provides programmatic access to partition schemes.

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

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class PartitionScheme _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IDroppable, IAlterable, ICreatable,  _
    IScriptable
'Usage
Dim instance As PartitionScheme
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class PartitionScheme : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IDroppable, IAlterable, ICreatable, IScriptable
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class PartitionScheme sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IDroppable, IAlterable, ICreatable, IScriptable
[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type PartitionScheme =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IDroppable 
        interface IAlterable 
        interface ICreatable 
        interface IScriptable 
    end
public final class PartitionScheme extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IDroppable, IAlterable, ICreatable, IScriptable

The PartitionScheme type exposes the following members.

Constructors

  Name Description
Public method PartitionScheme() Initializes a new instance of the PartitionScheme class.
Public method PartitionScheme(Database, String) Initializes a new instance of the PartitionScheme class, and sets the name of the partition scheme and the database to which it belongs.

Top

Properties

  Name Description
Public property Events Gets the events associated with the partition function.
Public property ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the PartitionScheme object.
Public property FileGroups Represents a collection of FileGroup objects. Each FileGroup object represents a filegroup defined on the database.
Public property ID Gets the zero-based ordinal of the PartitionScheme object, which specifies its position within the collection.
Public property Name Gets or sets a String which contains the name of the PartitionScheme. (Overrides NamedSmoObject.Name.)
Public property NextUsedFileGroup Gets or sets the name of the filegroup that has NEXT USED status.
Public property Parent Gets or sets the Database object that is the parent of the PartitionScheme object.
Public property PartitionFunction Gets or sets the name of the partition function used in this partition scheme.
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 PartitionScheme object property changes on the instance of SQL Server. 
Public method Create Creates a partition scheme on the instance of SQL Server as defined by the PartitionScheme object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes an existing partition scheme.
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 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 state information for the PartitionScheme object. (Overrides ScriptNameObjectBase.Refresh().)
Public method ResetNextUsed Resets the NEXT USED status of the partition scheme that has been marked as NEXT USED.
Public method Script() Generates a Transact-SQL script that can be used to re-create the partition scheme.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the partition scheme 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 indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

Partition schemes define the physical structure that is used to partition tables and indexes across multiple file groups.

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

To set PartitionScheme object properties, users must use the ALTER statement to alter permission on the database or ALTER ANY DATASPACE for permissions on the server or be a member of the db_owner or db_ddladmin fixed database roles or sysadmin fixed server role.

To create or drop a partition scheme, users must use ALTER for permission on the database or ALTER ANY DATASPACE for permission on the server or be a member of the db_owner or db_ddladmin fixed database roles or a member of sysadmin fixed server 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

Using Filegroups and Files to Store Data

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