Partition Class

Reference

Definition

Namespace:: Microsoft.AnalysisServices.Tabular

Assembly:: Microsoft.AnalysisServices.Tabular.dll

Package:: Microsoft.AnalysisServices.retail.amd64 v19.79.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a partition in a table. Partitions define the query against external data sources that return the rowsets of a Table.

public sealed class Partition : Microsoft.AnalysisServices.Tabular.NamedMetadataObject

type Partition = class
    inherit NamedMetadataObject

Public NotInheritable Class Partition
Inherits NamedMetadataObject

Inheritance: Object

MetadataObject

NamedMetadataObject
Partition

Constructors

Partition()

Create a new instance of the Partition class with default settings.

Properties

Annotations	Gets the collection object of all annotations in the current Partition.
DataCoverageDefinition	A reference to an optional DataCoverageDefinition that provides the hint regarding the data that is covered by the partition.
DataView	Determines which partitions should be selected to run queries against the model. The possible values are as follows. Full (0) - Partitions with DataView set to Default or Full are selected. Sample (1): Partitions with DataView set to Default or Sample are selected. SampleAndFull (2): All partitions are selected. Default (3) - Inherits from the default DataView of the Model object.
Description	The description of the partition, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.
ErrorMessage	The string that explains the error state associated with the current object. It is set by the engine only when the state of the object is one of these three values: SemanticError, DependencyError, or EvaluationError.This element applies only to partitions of the type Calculated.
ExtendedProperties	Gets the collection object of all extendedproperties in the current Partition.
IsRemoved	A Boolean specifying whether this object was removed from an object tree. (Inherited from MetadataObject)
Mode	Defines the method for making data available in the partition. Possible values are as follows. Import (0) Data will be imported from a data source. DirectQuery (1) Data will be queried dynamically from a data source. Default (2): Only partitions can use this value. When set, the partition will inherit the DefaultMode of the Model. Push (3): Data will be pushed into the partition. The Mode of a Partition can be set to Default (2), in which case it will inherit its Mode from the DefaultMode of the Model
Model	Gets the Tabular model that contains this object. (Inherited from MetadataObject)
ModifiedTime	The time that the object was last modified.
Name	Gets or Sets the Name of this object.
ObjectType	Gets the type of the object.
Parent	Parent object, null for Model objects.
QueryGroup	QueryGroup associated with the partition.
RefreshedTime	The time that the object was last refreshed.
RetainDataTillForceCalculate	Obsolete. Allows a calculated partition to have data which will not be affected by RefreshCalculate command when there is only data changes.
Source	Gets or sets the PartitionSource object.
SourceType	The type of source used by the Partition. This is either a query against a DataSource, or for calculated tables, an expression.
State	Provides information on the state of the partition. Possible values are as follows. Ready (1): The partition is queryable and has up-to-date data. NoData (3): The partition is queryable but has no data. This state applies only to partitions with a type other than Calculated. CalculationNeeded (4): The partition is not queryable and needs to be refreshed (that is, recalculated) to become functional. This state applies only to partitions of the type Calculated. SemanticError (5): The partition is in an error state because of an invalid expression and is not queryable. This state applies only to partitions of the type Calculated. EvaluationError (6): The partition is in an error state because of an error during expression evaluation. The partition is not queryable. This state applies only to partitions of the type Calculated. DependencyError (7): The partition is in an error state because some of its calculation dependencies are in an error state. The partition is not queryable. This state applies only to partitions of the type Calculated. Incomplete (8): Some parts of the partition have no data, and the partition needs to be refreshed to bring the data in. The partition is queryable. This state applies only to partitions of a type other than Calculated. SyntaxError (9): The partition is in an error state because of a syntax error in its expression. The partition is not queryable. This state applies only to partitions of the type Calculated.
Table	A reference to a Table object that owns this Partition.

Methods

Clone()	Creates a new, full copy of a Partition object.
CopyFrom(Partition)	Obsolete. Deprecated. Use CopyTo method instead.
CopyTo(Partition)	Copies a Partition object to the specified object.
Refresh(RefreshType)	Obsolete. Deprecated. Use RequestRefresh method instead.
Refresh(RefreshType, ICollection<OverrideCollection>)	Obsolete. Deprecated. Use RequestRefresh method instead.
Rename(String)	Obsolete. Deprecated. Use RequestRename method instead.
RequestMerge(IEnumerable<Partition>)	Request to merge partitions.
RequestRefresh(RefreshType)	Request refresh of this object.
RequestRefresh(RefreshType, ICollection<OverrideCollection>)	Request refresh of this object with overrides.
RequestRefreshPolicyImpact()	Request to analyze the refresh policy by running polling query on the partition.
RequestRename(String)	Request rename of this object.
Validate()	This API supports the product infrastructure and is not intended to be used directly from your code. Microsoft Internal Use Only. (Inherited from MetadataObject)

Applies to