Model Class

Definition

A Tabular model created at compatibility level 1200 or above.

public sealed class Model : Microsoft.AnalysisServices.Tabular.NamedMetadataObject
type Model = class
    inherit NamedMetadataObject
Public NotInheritable Class Model
Inherits NamedMetadataObject
Inheritance

Constructors

Model()

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

Properties

Annotations

Gets the collection object of all annotations in the current Model.

AutomaticAggregationOptions

Options for the automatic aggregation.

Collation

The collation sequence. Analysis Services uses Windows collations.

Culture

The name of the Culture used for formatting. Once it's used by a child object, this value can't be changed.

Cultures

Gets the collection object of all cultures in the current Model.

DataAccessOptions

Options for the M data engine.

Database

Gets the parent Database of the Model object.

DataSourceDefaultMaxConnections

DataSourceDefaultMaxConnections will be used for connections to a data source if MaxConnections is set to -1 on the data source object or if there is no corresponding data source object for the data source.

DataSources

Gets the collection object of all datasources in the current Model.

DataSourceVariablesOverrideBehavior

Controls whether this model allows data source variables to be overriden.

DefaultDataView

Used by partitions in the model to determine the type of query that retrieves data. A Full dataview retrieves an unfiltered rowset, used for in-memory models and deployed DirectQuery models. A Sample data view is a subset of data used during DirectQuery model design.

DefaultMeasure

A reference to a default measure.

DefaultMode

The default method for making data available in the partition.

DefaultPowerBIDataSourceVersion

Used by PBIX data source format conversion.

Description

The description of the model, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

DisableAutoExists

Disable auto exists behavior for SummarizeColumns

DiscourageCompositeModels

Determines whether to discourage composite models.

DiscourageImplicitMeasures

Determines whether to discourage the implicit measures.

Expressions

Gets the collection object of all expressions in the current Model.

ExtendedProperties

Gets the collection object of all extendedproperties in the current Model.

ForceUniqueNames

Determines whether measures can have the same names as any column in the model.

HasLocalChanges

Returns the status of local changes made to the model, which haven't been saved to the server.

If the model is not connected, this value is always False.

IsRemoved

A Boolean specifying whether this object was removed from an object tree.

(Inherited from MetadataObject)
MAttributes

The string that has M attributes.

MaxParallelismPerQuery

Maximum degree of parallelism for query in formula engine

MaxParallelismPerRefresh

Determines the max possible number of parallel tasks in data refresh, within the resource constraints of the hosting service.

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.

Perspectives

Gets the collection object of all perspectives in the current Model.

QueryGroups

Gets the collection object of all querygroups in the current Model.

Relationships

Gets the collection object of all relationships in the current Model.

Roles

Gets the collection object of all roles in the current Model.

Server

Gets the name of a Server object, where the server is an Analysis Services Tabular instance.

SourceQueryCulture

The name of the Culture used for formatting during refresh through Mashup.

StorageLocation

The location on disk to place the model.

StructureModifiedTime

The time that the structure of the object was last modified.

Tables

Gets the collection object of all tables in the current Model.

Methods

ApplyAutomaticAggregations()

Retrieves automatic aggregation recommendations from Analysis Services engine and applies changes to the model.

ApplyAutomaticAggregations(AutomaticAggregationOptions)

Retrieves automatic aggregation recommendations from Analysis Services engine and applies changes to the model.

ApplyPerformanceRecommendations(AutomaticAggregationOptions)
Obsolete.

Retrieves automatic aggregation recommendations from Analysis Services engine and applies changes to the model.

ApplyRefreshPolicies(Boolean, Boolean, Int32)

Adjusting the partitioning scheme of the incremental-refresh tables in the model, determined by the refresh-policy that is associated with them when the effective date that is used is based on the current time.

ApplyRefreshPolicies(DateTime, Boolean, Boolean, Int32)

Adjusting the partitioning scheme of the incremental-refresh tables in the model, determined by the refresh-policy that is associated with them and the specified effective date.

Clone()

Creates a new, full copy of a Model object.

CopyFrom(Model)
Obsolete.

Deprecated. Use CopyTo method instead.

CopyTo(Model)

Copies a Model object to the specified object.

ExecuteXmla(String)

Executes an XMLA request and updates the model tree to match model's definition on the Server.

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.

RequestRefresh(RefreshType)

Request refresh of this object.

RequestRefresh(RefreshType, DateTime)

Request refresh of this object.

RequestRefresh(RefreshType, ICollection<OverrideCollection>)

Request refresh of this object with overrides.

RequestRefresh(RefreshType, ICollection<OverrideCollection>, DateTime)

Request refresh of this object with overrides.

RequestRefresh(RefreshType, ICollection<OverrideCollection>, RefreshPolicyBehavior)

Request refresh of this object with overrides.

RequestRefresh(RefreshType, RefreshPolicyBehavior)

Request refresh of this object.

RequestRename(String)

Request rename of this object.

SaveChanges()

Saves the local changes made on the model tree to the version of the model residing in the database on the Server.

SaveChanges(SaveFlags)

Saves local modifications made on the model tree to the Server.

SaveChanges(SaveOptions)

Saves local modifications made on model tree to the Server.

Sync()

Synchronizes a local copy of the model tree to match the latest version stored on the Analysis Services instance, using the default options.

Sync(SyncOptions)

Synchronizes a local copy of the model tree to match the latest version stored on the Analysis Services instance, using the provided options.

UndoLocalChanges()

Reverts local changes made on the Model since the last time it was sync'ed with the Server.

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