Microsoft.AnalysisServices.Tabular Namespace

 

Updated: May 24, 2016

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.

ClassDescription
System_CAPS_pubclassAnnotation

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.

System_CAPS_pubclassAssembly

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

System_CAPS_pubclassAttributeHierarchy

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.

System_CAPS_pubclassAttributeHierarchyAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassCalculatedColumn

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.

System_CAPS_pubclassCalculatedPartitionSource

Represents a Partition of a CalculatedTable object.

System_CAPS_pubclassCalculatedTableColumn

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.

System_CAPS_pubclassClrAssembly

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

System_CAPS_pubclassColumn

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

System_CAPS_pubclassColumnAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassColumnCollection

Collection of Column objects.

System_CAPS_pubclassComAssembly

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

System_CAPS_pubclassCulture

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

System_CAPS_pubclassCultureAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassCultureCollection

Collection of Culture objects.

System_CAPS_pubclassDatabase

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.

System_CAPS_pubclassDatabaseCollection

Represents a collection of Database objects on a Server.

System_CAPS_pubclassDataColumn

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

System_CAPS_pubclassDataSource

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

System_CAPS_pubclassDataSourceAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassDataSourceCollection

Collection of DataSource objects.

System_CAPS_pubclassDeserializeOptions

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

System_CAPS_pubclassExternalModelRoleMember

For internal use only.

System_CAPS_pubclassHierarchy

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

System_CAPS_pubclassHierarchyAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassHierarchyCollection

Collection of Hierarchy objects.

System_CAPS_pubclassJsonScripter

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

System_CAPS_pubclassJsonSerializer

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.

System_CAPS_pubclassKPI

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

System_CAPS_pubclassKPIAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassLevel

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.

System_CAPS_pubclassLevelAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassLevelCollection

Collection of Level objects.

System_CAPS_pubclassLinguisticMetadata

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

System_CAPS_pubclassLinguisticMetadataAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassMeasure

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

System_CAPS_pubclassMeasureAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassMeasureCollection

Collection of Measure objects.

System_CAPS_pubclassMetadataObject

Base class in a class hierarchy of Tabular objects.

System_CAPS_pubclassMetadataObjectCollection<T, P>

Represents a collection of MetadataObjects.

System_CAPS_pubclassModel

A Tabular model created at compatibility level 1200 or above.

System_CAPS_pubclassModelAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassModelOperationResult

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

System_CAPS_pubclassModelRole

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

System_CAPS_pubclassModelRoleAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassModelRoleCollection

Collection of ModelRole objects.

System_CAPS_pubclassModelRoleMember

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

System_CAPS_pubclassModelRoleMemberAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassModelRoleMemberCollection

Collection of ModelRoleMember objects.

System_CAPS_pubclassNamedMetadataObject

Represents a Tabular metadata object by its name.

System_CAPS_pubclassNamedMetadataObjectCollection<T, P>

A collection of named metadata objects.

System_CAPS_pubclassObjectImpact

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.

System_CAPS_pubclassObjectReference

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

System_CAPS_pubclassObjectTranslation

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.

System_CAPS_pubclassObjectTranslationCollection

Collection of ObjectTranslation objects.

System_CAPS_pubclassOutOfSyncException

Provides the out-of-synchronization errors.

System_CAPS_pubclassPartition

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

System_CAPS_pubclassPartitionAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassPartitionCollection

Collection of Partition objects.

System_CAPS_pubclassPartitionSource

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

System_CAPS_pubclassPerspective

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.

System_CAPS_pubclassPerspectiveAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassPerspectiveCollection

Collection of Perspective objects.

System_CAPS_pubclassPerspectiveColumn

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

System_CAPS_pubclassPerspectiveColumnAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassPerspectiveColumnCollection

Collection of PerspectiveColumn objects.

System_CAPS_pubclassPerspectiveHierarchy

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

System_CAPS_pubclassPerspectiveHierarchyAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassPerspectiveHierarchyCollection

Collection of PerspectiveHierarchy objects.

System_CAPS_pubclassPerspectiveMeasure

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

System_CAPS_pubclassPerspectiveMeasureAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassPerspectiveMeasureCollection

Collection of PerspectiveMeasure objects.

System_CAPS_pubclassPerspectiveTable

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.

System_CAPS_pubclassPerspectiveTableAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassPerspectiveTableCollection

Collection of PerspectiveTable objects.

System_CAPS_pubclassPropertyChangeEntry

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

System_CAPS_pubclassProviderDataSource

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

System_CAPS_pubclassQueryPartitionSource

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

System_CAPS_pubclassRelationship

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

System_CAPS_pubclassRelationshipAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassRelationshipCollection

Collection of Relationship objects.

System_CAPS_pubclassRemovedSubtreeEntry

Represents information about a subtree removed from the object tree.

System_CAPS_pubclassRole

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

System_CAPS_pubclassRoleCollection

Represents a collection of Role objects.

System_CAPS_pubclassRowNumberColumn

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

System_CAPS_pubclassSaveOptions

Settings that control the behavior of the SaveChanges operation.

System_CAPS_pubclassSerializeOptions

Flags used to control the output of metadata object serialization.

System_CAPS_pubclassServer

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

System_CAPS_pubclassSessionTrace

Represents a trace session. This class cannot be inherited.

System_CAPS_pubclassSingleColumnRelationship

SingleColumnRelationship object.

System_CAPS_pubclassTable

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.

System_CAPS_pubclassTableAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassTableCollection

Collection of Table objects.

System_CAPS_pubclassTablePermission

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

System_CAPS_pubclassTablePermissionAnnotationCollection

Collection of Annotation objects.

System_CAPS_pubclassTablePermissionCollection

Collection of TablePermission objects.

System_CAPS_pubclassTomException

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

System_CAPS_pubclassTomInternalException

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

System_CAPS_pubclassTomValidationException

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

System_CAPS_pubclassTrace

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

System_CAPS_pubclassTraceCollection

Represents a collection of Trace objects.

System_CAPS_pubclassTraceColumnCollection

Represents a collection of TraceColumn values.

System_CAPS_pubclassTraceEvent

Represents a trace event.

System_CAPS_pubclassTraceEventArgs

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

System_CAPS_pubclassTraceEventCollection

Represents a collection of TraceEvent objects.

System_CAPS_pubclassTraceStoppedEventArgs

Represents a trace stopped event.

System_CAPS_pubclassUtils

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

System_CAPS_pubclassValidationError

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

System_CAPS_pubclassValidationResult

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

System_CAPS_pubclassWindowsModelRoleMember

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

InterfaceDescription
System_CAPS_pubinterfaceIMajorObject

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.

System_CAPS_pubinterfaceITrace

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

DelegateDescription
System_CAPS_pubdelegateTraceEventHandler

Represents the analysis services trace event handler.

System_CAPS_pubdelegateTraceStoppedEventHandler

Represents the event handler when the tracing is stopped.

EnumerationDescription
System_CAPS_pubenumAggregateFunction

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

System_CAPS_pubenumAlignment

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

System_CAPS_pubenumColumnType

An enumeration of possible values for a column type.

System_CAPS_pubenumCrossFilteringBehavior

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

System_CAPS_pubenumDatasourceIsolation

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

System_CAPS_pubenumDataSourceType

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

System_CAPS_pubenumDataType

Describes the type of data contained in the column.

System_CAPS_pubenumDataViewType

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

System_CAPS_pubenumDateTimeRelationshipBehavior

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

System_CAPS_pubenumImpersonationMode

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

System_CAPS_pubenumModelPermission

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

System_CAPS_pubenumModeType

Defines the method for making data available in the partition.

System_CAPS_pubenumObjectState

An enumeration of possible values for object state.

System_CAPS_pubenumObjectType

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.

System_CAPS_pubenumPartitionSourceType

An enumeration of possible values for a partition source.

System_CAPS_pubenumRefreshType

An enumeration of possible values for a refresh type.

System_CAPS_pubenumRelationshipEndCardinality

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

System_CAPS_pubenumRelationshipType

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

System_CAPS_pubenumRoleMemberType

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.

System_CAPS_pubenumSaveFlags

Flags used to control the behavior of a SaveChanges operation.

System_CAPS_pubenumSecurityFilteringBehavior

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

System_CAPS_pubenumTranslatedProperty

Specifies which property of the object is being translated.

Return to top
Show: