Export (0) Print
Expand All

PartitionFunction Class

The PartitionFunction object provides programmatic access to partition functions.

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

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type PartitionFunction =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IDroppable 
        interface IAlterable 
        interface ICreatable 
        interface IScriptable 
        interface IExtendedProperties 
    end

The PartitionFunction type exposes the following members.

  NameDescription
Public methodPartitionFunction()Initializes a new instance of the PartitionFunction class.
Public methodPartitionFunction(Database, String)Initializes a new instance of the PartitionFunction class for the specified database and with the specified name.
Top

  NameDescription
Public propertyCreateDateGets the date and time when the partition function was created.
Public propertyEventsGets the events associated with the partition function.
Public propertyExtendedPropertiesRepresents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the partition function.
Public propertyIDGets the zero-based ordinal of the PartitionFunction object, which specifies its position within the collection.
Public propertyNameGets or sets a String which contains the name of the PartitionFunction. (Overrides NamedSmoObject.Name.)
Public propertyNumberOfPartitionsGets the number of partitions.
Public propertyParentGets or sets the Database object that is the parent of the PartitionFunction object.
Public propertyPartitionFunctionParametersRepresents a collection of PartitionFunctionParameter objects. Each PartitionFunctionParameters object represents a partition function parameter defined on the partition function.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyRangeTypeGets or sets the placement of boundary values in relation to the interval.
Public propertyRangeValuesGets or sets range values that define the distribution of the partition function.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
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 PartitionFunction object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates a partition function on the instance of Microsoft SQL Server as defined by the PartitionFunction object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves an existing partition function.
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 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 methodMergeRangePartitionMerges two existing range partitions based on the specified boundary value.
Public methodRefreshRefreshes the state information for the PartitionFunction object. (Overrides ScriptNameObjectBase.Refresh().)
Public methodScript()Generates a Transact-SQL script that can be used to re-create the partition function.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the partition function as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodSplitRangePartitionSplits an existing range partition into two parts based on a supplied boundary value.
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 indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Top

Partition functions are used to partition tables and indexes across multiple file groups.

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

To set PartitionFunction object propertied, users must ALTER permission on the database or ALTER ANY DATASPACE 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.

To create or drop a partition function, users must have ALTER permission on the database or ALTER ANY DATASPACE 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.

To merge or split the range values on the partition function, users must have ALTER permission on the database or ALTER ANY DATASPACE 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.

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