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)


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

NameDescription
System_CAPS_pubmethodPartitionFunction()

Initializes a new instance of the PartitionFunction class.

System_CAPS_pubmethodPartitionFunction(Database, String)

Initializes a new instance of the PartitionFunction class for the specified database and with the specified name.

NameDescription
System_CAPS_pubpropertyCreateDate

Gets the date and time when the partition function was created.

System_CAPS_pubpropertyEvents

Gets the events associated with the partition function.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the partition function.

System_CAPS_pubpropertyID

Gets the zero-based ordinal of the PartitionFunction object, which specifies its position within the collection.

System_CAPS_pubpropertyName

Gets or sets a String which contains the name of the PartitionFunction.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyNumberOfPartitions

Gets the number of partitions.

System_CAPS_pubpropertyParent

Gets or sets the Database object that is the parent of the PartitionFunction object.

System_CAPS_pubpropertyPartitionFunctionParameters

Represents a collection of PartitionFunctionParameter objects. Each PartitionFunctionParameters object represents a partition function parameter defined on the partition function.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyRangeType

Gets or sets the placement of boundary values in relation to the interval.

System_CAPS_pubpropertyRangeValues

Gets or sets range values that define the distribution of the partition function.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any PartitionFunction object property changes on the instance of Microsoft SQL Server. 

System_CAPS_pubmethodCreate()

Creates a partition function on the instance of Microsoft SQL Server as defined by the PartitionFunction object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes an existing partition function.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodMergeRangePartition(Object)

Merges two existing range partitions based on the specified boundary value.

System_CAPS_pubmethodRefresh()

Refreshes the state information for the PartitionFunction object. (Overrides ScriptNameObjectBase.Refresh().)

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the partition function.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the partition function as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodSplitRangePartition(Object)

Splits an existing range partition into two parts based on a supplied boundary value.

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

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

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

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.

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.

Return to top
Show: