Microsoft.AnalysisServices.Tabular Namespace

Provides an object API used to administer Analysis Services tabular server instances, databases, roles and assemblies. This namespace targets tabular databases at compatibility level 1200, where objects are described in tabular metadata as tables, columns, and relationships.

Script and managed code that calls into AMO should use the classes and members in this namespace to represent objects in a tabular model. When using this namespace, remember to also add a reference to Microsoft.AnalysisServices.Core.

Classes

Annotation

An extension of the schema used for passing object-specific information in the form of name-value pairs, for use by a client application. Analysis Services does not interpret or validate annotations. Annotations are defined as a child of a logical metadata object in the model.

Assembly

Represents a COM or .NET library that can contain several classes with several methods; all of which are potential stored procedures.

AttributeHierarchy

Represents the attribute hierarchy of a column in a table. It is an optional child object of a Column object and is implicitly created by the server. When the attribute hierarchy is present, the column becomes available as a hierarchy in the multidimensional engine and can be queried by using MDX.

AttributeHierarchyAnnotationCollection

Collection of Annotation objects.

CalculatedColumn

Represents a column that is based on a DAX expression in a Table that also contains DataColumns and a RowNumberColumn. A CalculatedColumn can also be added to a calculated table.

CalculatedPartitionSource

Represents a Partition of a CalculatedTable object.

CalculatedTableColumn

Represents a column in a Table that is based on a DAX expression. A collection of CalculatedTableColumn, under a Table object bound to a partition with Source of type CalculatedPartitionSource, results in a calculated table.

ClrAssembly

Enables you to manage and use a ClrAssembly. This class cannot be inherited.

Column

Represents a base class of a column object of a Tabular model, used to specify a DataColumn, RowNumberColumn, CalculatedColumn, or CalculatedTableColumn.

ColumnAnnotationCollection

Collection of Annotation objects.

ColumnCollection

Collection of Column objects.

ComAssembly

Enables you to manage and use a ComAssembly. This class cannot be inherited.

Culture

Represents a user culture. It is a child of a Model object, used for translating strings and formatting values.

CultureAnnotationCollection

Collection of Annotation objects.

CultureCollection

Collection of Culture objects.

Database

Specifies an Analysis Services Tabular or Multidimensional database. This class cannot be inherited. Server mode and model type will determine whether you can subsequently create or modify the model tree. Specifically, if you call Tabular.Database, you can modify its model only when the model is Tabular at compatibility level 1200.

DatabaseCollection

Represents a collection of Database objects on a Server.

DataColumn

Represents a column in a Table that gets data from an external data source.

DataSource

Defines an open connection to an external data source for import, refresh, or DirectQuery operations on a Tabular Model.

DataSourceAnnotationCollection

Collection of Annotation objects.

DataSourceCollection

Collection of DataSource objects.

DeserializeOptions

Flags that control how the JSON document is treated during deserialization.

ExternalModelRoleMember

For internal use only.

Hierarchy

Represents a collection of levels that provide a logical hierarchical drilldown path for client applications. It is a child of a Table object.

HierarchyAnnotationCollection

Collection of Annotation objects.

HierarchyCollection

Collection of Hierarchy objects.

JsonScripter

Helper class for scripting out a Tabular Database or Tabular metadata object into JSON script.

JsonSerializer

Two-way conversion of an in-memory object tree to JSON. JSON is used for object definitions in a Tabular model or Tabular database at compatibility level 1200 and greater.

KPI

Represents a Key Performance Indicator object. It is a child of a Measure object.

KPIAnnotationCollection

Collection of Annotation objects.

Level

Represents a level in a hierarchy that provides a logical hierarchical drilldown path for client applications. It is a child of a Hierarchy object. The level is based on the values in a column.

LevelAnnotationCollection

Collection of Annotation objects.

LevelCollection

Collection of Level objects.

LinguisticMetadata

Holds synonym information for the Tabular model. It is a child of a Culture object.

LinguisticMetadataAnnotationCollection

Collection of Annotation objects.

Measure

Represents a value that is calculated based on an expression. It is a child of a Table object.

MeasureAnnotationCollection

Collection of Annotation objects.

MeasureCollection

Collection of Measure objects.

MetadataObject

Base class in a class hierarchy of Tabular objects.

MetadataObjectCollection<T,P>

Represents a collection of MetadataObjects.

Model

A Tabular model created at compatibility level 1200 or above.

ModelAnnotationCollection

Collection of Annotation objects.

ModelOperationResult

Represents result of the operation on Model, such as Sync(), SaveChanges()

ModelRole

Defines a set of user principals for whom security rules are applied. It is a child of a Model object.

ModelRoleAnnotationCollection

Collection of Annotation objects.

ModelRoleCollection

Collection of ModelRole objects.

ModelRoleMember

Defines a user principal that belongs to the Role. It is a child of a Role object.

ModelRoleMemberAnnotationCollection

Collection of Annotation objects.

ModelRoleMemberCollection

Collection of ModelRoleMember objects.

NamedMetadataObject

Represents a Tabular metadata object by its name.

NamedMetadataObjectCollection<T,P>

A collection of named metadata objects.

ObjectImpact

Represents a modification to the model tree resulting from one or more user operations that either add new objects, remove existing objects, or change object properties.

ObjectReference

Provides linkage to an object. This class cannot be inherited.

ObjectTranslation

Represents the translations of metadata properties for the Culture parent object. Properties like the Name and Description of a metadata object can be translated. If they are not translated, the properties specified on the main object are used. The ObjectTranslation object has a weakly typed reference to the object that it is translating.

ObjectTranslationCollection

Collection of ObjectTranslation objects.

OutOfSyncException

Provides the out-of-synchronization errors.

Partition

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

PartitionAnnotationCollection

Collection of Annotation objects.

PartitionCollection

Collection of Partition objects.

PartitionSource

A base class for all partition sources: QueryPartitionSource, CalculatedPartitionSource, MPartitionSource (reserved for future use).

Perspective

Defines a logical view over the Model and is a child of a Model object. It allows hiding Tables, Columns, Measures, and Hierarchies so that end users can look at a smaller subset of the large data model.

PerspectiveAnnotationCollection

Collection of Annotation objects.

PerspectiveCollection

Collection of Perspective objects.

PerspectiveColumn

Includes a Column of a Table in the Perspective. It is a child of a PerspectiveTable object.

PerspectiveColumnAnnotationCollection

Collection of Annotation objects.

PerspectiveColumnCollection

Collection of PerspectiveColumn objects.

PerspectiveHierarchy

Includes a Hierarchy of a Table in the Perspective. It is a child of a PerspectiveTable object.

PerspectiveHierarchyAnnotationCollection

Collection of Annotation objects.

PerspectiveHierarchyCollection

Collection of PerspectiveHierarchy objects.

PerspectiveMeasure

Includes a Measure of a Table in the Perspective. It is a child of a PerspectiveTable object.

PerspectiveMeasureAnnotationCollection

Collection of Annotation objects.

PerspectiveMeasureCollection

Collection of PerspectiveMeasure objects.

PerspectiveTable

Includes a Table into the Perspective. It is a child of a Perspective object. The PerspectiveColumns, PerspectiveMeasures, and PerspectiveHierarchies child objects allow customizing which parts of the Table are visible in the Perspective.

PerspectiveTableAnnotationCollection

Collection of Annotation objects.

PerspectiveTableCollection

Collection of PerspectiveTable objects.

PropertyChangeEntry

Represents information about the modification of a metadata object's property.

ProviderDataSource

Represents a data source that uses a connection string for the connection.

QueryPartitionSource

Provides a query in the native query language of the external data source used to retrieve a slice of data for a single partition.

Relationship

Represents a logical relationship between two Table objects. It is a child of a Model object.

RelationshipAnnotationCollection

Collection of Annotation objects.

RelationshipCollection

Collection of Relationship objects.

RemovedSubtreeEntry

Represents information about a subtree removed from the object tree.

Role

Represents the level of security associated with a group of users. This class cannot be inherited.

RoleCollection

Represents a collection of Role objects.

RowNumberColumn

Represents an internal column automatically added by the Server to every Table after the object is created on the server.

SaveOptions

Settings that control the behavior of the SaveChanges operation.

SerializeOptions

Flags used to control the output of metadata object serialization.

Server

Represents an instance of Analysis Services and provides methods and members that enable you to control that instance. This class cannot be inherited.

SessionTrace

Represents a trace session. This class cannot be inherited.

SingleColumnRelationship

SingleColumnRelationship object.

Table

Represents a Table in the data model. A Table object is a member of the TableCollection object under a Model object. It contains a ColumnCollection. Rows are based on Partition object or a CalculatedPartitionSource if the Table is a calculated table.

TableAnnotationCollection

Collection of Annotation objects.

TableCollection

Collection of Table objects.

TablePermission

Defines the security rules of the Role on the Table. It is a child of a Role object.

TablePermissionAnnotationCollection

Collection of Annotation objects.

TablePermissionCollection

Collection of TablePermission objects.

TomException

Represents a generic exception that is raised when a Tabular object model error or warning occurs.

TomInternalException

Represents an internal error whose origin is either indeterminate or occurs lower in the stack.

TomValidationException

Represents an inconsistency in the state of a metadata object that's preventing completion of the current operation.

Trace

Provides a mechanism to store event logs which can be later viewed or replayed. This class cannot be inherited.

TraceCollection

Represents a collection of Trace objects.

TraceColumnCollection

Represents a collection of TraceColumn values.

TraceEvent

Represents a trace event.

TraceEventArgs

Defines the identifiers and values associated with a trace event. This class cannot be inherited.

TraceEventCollection

Represents a collection of TraceEvent objects.

TraceStoppedEventArgs

Represents a trace stopped event.

Utils

General purpose utilities used primarily for name validation and syntax checks.

ValidationError

Represents an error found during validation of a metadata object tree.

ValidationResult

Represents the result of consistency validation of a metadata object tree.

WindowsModelRoleMember

Represents an individual Windows user account or a Windows security group.

Interfaces

IMajorObject

Major objects of a Tabular solution, such as Server, Database, Role, and Trace. Major objects are an artifact of the legacy AMO client library, where objects are classified as Major or Minor.

ITrace

Provides a mechanism to store event logs which can be viewed or replayed later.

Enums

AggregateFunction

Specifies the aggregate function to be used by reporting tools to summarize column values.

Alignment

An enumeration of possible values for aligning data in a cell.

ColumnType

An enumeration of possible values for a column type.

CrossFilteringBehavior

Indicates how relationships influence filtering of data. The enumeration defines the possible behaviors.

DatasourceIsolation

Controls the locking behavior of the SQL statements when executing commands against the data source.

DataSourceType

The type of DataSource. Currently, the only possible value is Provider.

DataType

Describes the type of data contained in the column.

DataViewType

Determines which partitions are to be selected to run queries against the model.

DateTimeRelationshipBehavior

When joining two date time columns, indicates whether to join on date and time parts or on date part only.

ImpersonationMode

Determines how credentials are obtained for an impersonated connection to a data source during data import or refresh.

ModelPermission

An enumeration of possible model permissions that can be used in a Role object.

ModeType

Defines the method for making data available in the partition.

ObjectState

An enumeration of possible values for object state.

ObjectType

An enumeration of logical metadata objects in a Tabular model or database. You can use ObjectType to return the type if you don't already know what it is.

PartitionSourceType

An enumeration of possible values for a partition source.

RefreshType

An enumeration of possible values for a refresh type.

RelationshipEndCardinality

An enumeration of possible values for defining cardinality on either side of a table relationship.

RelationshipType

The type of relationship. Currently, the only possible value is SingleColumn.

RoleMemberType

Indicates whether the particular member of a security role is an individual user or a group of users, or if the member is automatically detected.

SaveFlags

Flags used to control the behavior of a SaveChanges operation.

SecurityFilteringBehavior

Indicates how relationships influence filtering of data when evaluating row-level security expressions. The enumeration defines the possible behaviors.

TranslatedProperty

Specifies which property of the object is being translated.

Delegates

TraceEventHandler

Represents the analysis services trace event handler.

TraceStoppedEventHandler

Represents the event handler when the tracing is stopped.