Microsoft.AnalysisServices.Tabular 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
提供用于管理 Analysis Services 表格服务器实例、数据库、角色和程序集的对象 API。 此命名空间面向兼容级别为 1200 或更高版本的表格数据库,其中表格元数据中将对象描述为表、列和关系。
调用 AMO 的脚本和托管代码应使用此命名空间中的类和成员来表示表格模型中的对象。 使用此命名空间时,请记住还要添加对 Microsoft.AnalysisServices.Core的引用。
类
AlternateOf |
表示 AlternativeSource 对象。 它是 Table 或 Column 对象的子级。 |
AlternateOfAnnotationCollection |
Annotation 对象的集合。 |
Annotation |
用于以名称值对的形式传递对象特定信息的架构的扩展,供客户端应用程序使用。 Analysis Services 不解释或验证批注。 批注定义为模型中逻辑元数据对象的子级。 |
AttributeHierarchy |
表示表中列的属性层次结构。 它是 Column 对象的可选子对象,由服务器隐式创建。 当属性层次结构存在时,列将作为多维引擎中的层次结构提供,并且可以使用 MDX 进行查询。 |
AttributeHierarchyAnnotationCollection |
Annotation 对象的集合。 |
AttributeHierarchyExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
AuthenticationKind |
DataSource.Credential.AuthenticationKind 的常量,用于定义数据源的身份验证方式。 |
AutomaticAggregationOptions |
Model.AutomaticAggregationOptions 属性的值 |
BasicRefreshPolicy |
表示 BasicRefreshPolicy 对象。 它是 Table 对象的子级。 |
CalculatedColumn |
表示基于表中包含 DataColumns 和 RowNumberColumn 的 DAX 表达式的列。 还可以将 CalculatedColumn 添加到计算表中。 |
CalculatedPartitionSource |
表示 CalculatedTable 对象的分区。 |
CalculatedTableColumn |
表示基于 DAX 表达式的表中的列。 一个 CalculatedTableColumn 集合,在绑定到具有 CalculatedPartitionSource 类型的源的分区的 Table 对象下,生成计算表。 |
CalculationGroup |
表示计算项的集合。 |
CalculationGroupAnnotationCollection |
Annotation 对象的集合。 |
CalculationGroupExpression |
表格 CalculationGroupExpression 对象。 在此对象上定义的表达式将应用于 DAX 查询中的选定度量值,而无法应用任何计算项。 |
CalculationGroupSource |
表示基于 CalculationGroup 内容的分区。 |
CalculationItem |
表格计算项。 |
CalculationItemCollection |
CalculationItem 对象的集合。 |
ChangedProperty |
表示对某个对象属性的更改的指示。 |
Column |
表示表格模型的列对象的基类,用于指定 DataColumn、RowNumberColumn、CalculatedColumn 或 CalculatedTableColumn。 |
ColumnAnnotationCollection |
Annotation 对象的集合。 |
ColumnChangedPropertyCollection |
ChangedProperty 对象的集合。 |
ColumnCollection |
Column 对象的集合。 |
ColumnExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
ColumnPermission |
定义列上角色的安全规则。 它是 TablePermission 对象的子级。 |
ColumnPermissionAnnotationCollection |
Annotation 对象的集合。 |
ColumnPermissionCollection |
ColumnPermission 对象的集合。 |
ColumnPermissionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
CompatibilityViolationException |
表示当模型中的对象或属性需要高于数据库支持的兼容级别时引发的异常。 |
ConnectionAddress |
连接的地址。 它包含协议名称和特定于协议的属性,例如服务器和数据库名称。 |
ConnectionAddressProperty |
DataSource.Address 字典中的键 |
ConnectionDetails |
用于连接数据源的协议和地址 |
Credential |
用于对结构化数据源进行身份验证的选项 |
CredentialProperty |
DataSource.Credential 字典中的键 |
Culture |
表示用户区域性。 它是 Model 对象的子级,用于转换字符串和格式设置值。 |
CultureAnnotationCollection |
Annotation 对象的集合。 |
CultureCollection |
Culture 对象的集合。 |
CultureExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
CustomJsonProperty<TOwner> |
将 JSON 对象表示为非重复属性集合的自定义属性的基类。 |
DataAccessOptions |
Model.DataAccessOptions 属性的值 |
Database |
指定 Analysis Services 表格或多维数据库。 无法继承此类。 服务器模式和模型类型将确定随后是否可以创建或修改模型树。 具体而言,如果调用 Tabular.Database,则只能在模型为兼容级别 1200 的表格时修改其模型。 |
DatabaseCollection |
表示 Database 对象的集合。 无法继承此类。 |
DataColumn |
表示表中从外部数据源获取数据的列。 |
DataCoverageDefinition |
表格 DataCoverageDefinition 对象。 在此对象上定义的表达式提供有关分区中的数据的提示。 |
DataCoverageDefinitionAnnotationCollection |
Annotation 对象的集合。 |
DataSource |
定义与外部数据源的打开连接,以便对表格 Model执行导入、刷新或 DirectQuery 操作。 |
DataSourceAnnotationCollection |
Annotation 对象的集合。 |
DataSourceCollection |
DataSource 对象的集合。 |
DataSourceExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
DataSourceOptions |
DataSource.Options 属性的值 |
DataSourceProtocol |
可能的 DataSource.Protocol 值 |
DeserializeOptions |
用于控制在反序列化期间如何处理 JSON 文档的标志。 |
DetailRowsDefinition |
表示 DetailRowsDefinition 对象。 它是 Measure 或 Table 对象的子级。 |
EntityPartitionSource |
表示从基础 DataSource/Provider 引用对象所支持的分区。 |
ExtendedProperty |
架构的扩展,用于通过 TOM 和 CSDL 以名称值对的形式传递特定于对象的信息。 如果类型设置为 JSON,Analysis Service 将验证它是否为格式良好的 JSON。 ExtendedProperty 定义为模型中逻辑元数据对象的子级。 |
ExternalModelRoleMember |
仅供内部使用。 |
FormatStringDefinition |
表示 FormatStringDefinition 对象。 它是 Measure 或 CalculationItem 的子级。 |
GroupByColumn |
列对象的扩展,该对象保存其分组依据的列列表 |
GroupByColumnCollection |
GroupByColumn 对象的集合。 |
Hierarchy |
表示为客户端应用程序提供逻辑分层向下钻取路径的级别集合。 它是 Table 对象的子级。 |
HierarchyAnnotationCollection |
Annotation 对象的集合。 |
HierarchyChangedPropertyCollection |
ChangedProperty 对象的集合。 |
HierarchyCollection |
Hierarchy 对象的集合。 |
HierarchyExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
InferredPartitionSource |
表示通过执行系统生成的查询来填充其数据的分区。 |
JsonExtendedProperty |
表示具有 Json 值的 ExtendedProperty。 |
JsonScripter |
用于将表格 aatabase 或元数据对象编写成 JSON 脚本的帮助程序类。 |
JsonSerializer |
将内存中对象树双向转换为 JSON。 JSON 用于兼容级别为 1200 及更高版本的表格模型或表格数据库中的对象定义。 |
KPI |
表示关键绩效指标对象。 它是 Measure 对象的子级。 |
KPIAnnotationCollection |
Annotation 对象的集合。 |
KPIExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
Level |
表示层次结构中的级别,该级别为客户端应用程序提供逻辑分层向下钻取路径。 它是 Hierarchy 对象的子级。 级别基于列中的值。 |
LevelAnnotationCollection |
Annotation 对象的集合。 |
LevelChangedPropertyCollection |
ChangedProperty 对象的集合。 |
LevelCollection |
Level 对象的集合。 |
LevelExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
LinguisticMetadata |
保存表格模型的同义词信息。 它是 Culture 对象的子级。 |
LinguisticMetadataAnnotationCollection |
Annotation 对象的集合。 |
LinguisticMetadataExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
Measure |
表示基于表达式计算的值。 它是 Table 对象的子级。 |
MeasureAnnotationCollection |
Annotation 对象的集合。 |
MeasureChangedPropertyCollection |
ChangedProperty 对象的集合。 |
MeasureCollection |
Measure 对象的集合。 |
MeasureExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
MetadataObject |
表格对象的类层次结构中的基类。 |
MetadataObjectCollection<T,P> |
表示元数据对象的集合。 |
Model |
在兼容级别 1200 或更高版本创建的表格模型。 |
ModelAnnotationCollection |
Annotation 对象的集合。 |
ModelExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
ModelOperationResult |
表示模型上的操作的结果,如 Sync()、 SaveChanges() |
ModelRole |
定义一组应用安全规则的用户主体。 它是 Model 对象的子级。 |
ModelRoleAnnotationCollection |
Annotation 对象的集合。 |
ModelRoleCollection |
ModelRole 对象的集合。 |
ModelRoleExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
ModelRoleMember |
定义属于角色的用户主体。 它是 Role 对象的子级。 |
ModelRoleMemberAnnotationCollection |
Annotation 对象的集合。 |
ModelRoleMemberCollection |
ModelRoleMember 对象的集合。 |
ModelRoleMemberExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
MPartitionSource |
表示 M 表达式支持的分区。 |
NamedExpression |
可由一个或多个分区使用的命名表达式。 |
NamedExpressionAnnotationCollection |
Annotation 对象的集合。 |
NamedExpressionCollection |
NamedExpression 对象的集合。 |
NamedExpressionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
NamedMetadataObject |
按名称表示表格元数据对象。 |
NamedMetadataObjectCollection<T,P> |
命名元数据对象的集合。 |
ObjectImpact |
表示对模型树的修改,这些操作由一个或多个用户操作生成,这些操作可以添加新对象、删除现有对象或更改对象属性。 |
ObjectReference |
提供与对象的链接。 无法继承此类。 |
ObjectTranslation |
表示 Culture 父对象的元数据属性的翻译。 可以转换元数据对象的名称和说明等属性。 如果未转换这些属性,将使用在主对象上指定的属性。 ObjectTranslation 对象对要转换的对象具有弱类型引用。 |
ObjectTranslationCollection |
ObjectTranslation 对象的集合。 |
OutOfSyncException |
提供同步外错误。 |
ParquetPartitionSource |
表示通过执行系统生成的查询来填充其数据的分区。 |
Partition |
表示表中的分区。 分区针对返回 Table行集的外部数据源定义查询。 |
PartitionAnnotationCollection |
Annotation 对象的集合。 |
PartitionCollection |
Partition 对象的集合。 |
PartitionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PartitionSource |
所有分区源的基类:QueryPartitionSource、CalculatedPartitionSource、MPartitionSource、EntityPartitionSource。 |
Perspective |
定义模型上的逻辑视图,并且是 Model 对象的子级。 它允许隐藏表、列、度量值和层次结构,以便最终用户可以查看较小的大型数据模型的子集。 |
PerspectiveAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveCollection |
Perspective 对象的集合。 |
PerspectiveColumn |
在透视中包含表的列。 它是 PerspectiveTable 对象的子级。 |
PerspectiveColumnAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveColumnCollection |
PerspectiveColumn 对象的集合。 |
PerspectiveColumnExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PerspectiveExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PerspectiveHierarchy |
在透视中包含表的层次结构。 它是 PerspectiveTable 对象的子级。 |
PerspectiveHierarchyAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveHierarchyCollection |
PerspectiveHierarchy 对象的集合。 |
PerspectiveHierarchyExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PerspectiveMeasure |
在透视中包含表的度量值。 它是 PerspectiveTable 对象的子级。 |
PerspectiveMeasureAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveMeasureCollection |
PerspectiveMeasure 对象的集合。 |
PerspectiveMeasureExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PerspectiveSet |
PerspectiveSet 对象。 |
PerspectiveSetAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveSetCollection |
PerspectiveSet 对象的集合。 |
PerspectiveSetExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PerspectiveTable |
将表包含在透视中。 它是 Perspective 对象的子级。 PerspectiveColumns、PerspectiveMeasures 和 PerspectiveHierarchies 子对象允许自定义在 Perspective 中可见表的各个部分。 |
PerspectiveTableAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveTableCollection |
PerspectiveTable 对象的集合。 |
PerspectiveTableExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PolicyRangePartitionSource |
表示基于范围刷新策略的分区 |
PrivacyClass |
DataSource.Credential.PrivacySetting 的常量,用于定义如何在生成的查询中与其他数据源共享数据源的数据。 |
PropertyChangeEntry |
表示有关修改元数据对象的属性的信息。 |
ProviderDataSource |
表示使用连接字符串进行连接的数据源。 |
QueryGroup |
表示 QueryGroup 对象。 与 Partition 或 NamedExpression 对象关联。 |
QueryGroupAnnotationCollection |
Annotation 对象的集合。 |
QueryGroupCollection |
QueryGroup 对象的集合。 |
QueryPartitionSource |
以外部数据源的本机查询语言提供查询,用于检索单个分区的数据切片。 |
RefreshPolicy |
表示抽象 RefreshPolicy 对象。 它是 Table 对象的子级。 |
RefreshPolicyAnnotationCollection |
Annotation 对象的集合。 |
RefreshPolicyExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
RelatedColumnDetails |
列对象的扩展,该对象保存其分组依据的列列表 |
Relationship |
表示两个 Table 对象之间的逻辑关系。 它是 Model 对象的子级。 |
RelationshipAnnotationCollection |
Annotation 对象的集合。 |
RelationshipChangedPropertyCollection |
ChangedProperty 对象的集合。 |
RelationshipCollection |
Relationship 对象的集合。 |
RelationshipExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
RemovedSubtreeEntry |
表示有关从对象树中删除的子树的信息。 |
Role |
表示与一组用户关联的安全级别。 无法继承此类。 |
RoleCollection |
表示 Role 对象的集合。 无法继承此类。 |
RowNumberColumn |
表示服务器在服务器上创建对象后自动添加到每个表的内部列。 |
SaveOptions |
表示控制模型 SaveChanges 操作行为的高级设置。 |
SerializeOptions |
用于控制元数据对象序列化输出的标志。 |
Server |
表示 Analysis Services 的一个实例,并提供可用于控制该实例的方法和成员。 无法继承此类。 |
SessionTrace |
表示跟踪会话。 无法继承此类。 |
Set |
设置对象。 |
SetAnnotationCollection |
Annotation 对象的集合。 |
SetCollection |
Set 对象的集合。 |
SetExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
SingleColumnRelationship |
SingleColumnRelationship 对象。 |
StringExtendedProperty |
表示具有字符串值的 ExtendedProperty。 |
StructuredDataSource |
表示使用基于 JSON 的可扩展协议定义检索数据的位置和机制的数据源。 |
SyncOptions |
控制同步操作行为的设置。 |
Table |
表示数据模型中的表。 Table 对象是 Model 对象下 TableCollection 对象的成员。 它包含一个 ColumnCollection。 如果表是计算表,则行基于 Partition 对象或 CalculatedPartitionSource。 |
TableAnnotationCollection |
Annotation 对象的集合。 |
TableChangedPropertyCollection |
ChangedProperty 对象的集合。 |
TableCollection |
Table 对象的集合。 |
TableExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
TablePermission |
定义表上角色的安全规则。 它是 Role 对象的子级。 |
TablePermissionAnnotationCollection |
Annotation 对象的集合。 |
TablePermissionCollection |
TablePermission 对象的集合。 |
TablePermissionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
TmdlSerializer |
内存中对象树到 TMDL 的双向转换。 TMDL 用于兼容级别为 1200 及更高版本的表格模型或表格数据库中的对象定义。 |
TomException |
表示在出现表格对象模型错误或警告时引发的泛型异常。 |
TomInternalException |
表示内部错误,其原点不确定或在堆栈中较低。 |
TomValidationException |
表示元数据对象的状态不一致,该状态阻止完成当前操作。 |
Trace |
提供一种机制,用于存储可在以后查看或重播的事件日志。 无法继承此类。 |
TraceCollection |
表示 Trace 对象的集合。 无法继承此类。 |
TraceColumnCollection |
表示 TraceColumn 对象的集合。 无法继承此类。 |
TraceEvent |
表示跟踪事件。 |
TraceEventArgs |
定义与跟踪事件关联的标识符和值。 无法继承此类。 |
TraceEventCollection |
表示 TraceEvent 对象的集合。 无法继承此类。 |
TraceStoppedEventArgs |
表示跟踪停止的事件。 |
Utils |
主要用于名称验证和语法检查的常规用途实用工具。 |
ValidationError |
表示在验证元数据对象树期间发现的错误。 |
ValidationResult |
表示元数据对象树的一致性验证的结果。 |
Variation |
变体对象。 |
VariationAnnotationCollection |
Annotation 对象的集合。 |
VariationCollection |
变体对象的集合。 |
VariationExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
WindowsModelRoleMember |
表示单个 Windows 用户帐户或 Windows 安全组。 |
接口
IMajorObject |
表格解决方案的主要对象,例如服务器、数据库、角色和跟踪。 主要对象是旧版 AMO 客户端库的项目,其中对象被归类为“主要”或“次要”。 |
IMetadataObjectWithLineage |
可能具有世系关系的元数据对象。 |
ITrace |
提供一种机制,用于存储可在以后查看或重播的事件日志。 |
枚举
AggregateFunction |
指定报表工具用于汇总列值的聚合函数。 |
Alignment |
用于对齐单元格中的数据的可能值的枚举。 |
CalculationGroupSelectionMode |
用于选择不调用计算项的计算组的选项。 |
ColumnType |
列类型的可能值的枚举。 |
ContentType |
字符串内容的类型。 E.g. XML或 JSON。 |
CrossFilteringBehavior |
指示关系如何影响数据的筛选。 枚举定义可能的行为。 |
DatasourceIsolation |
控制针对数据源执行命令时 SQL 语句的锁定行为。 |
DataSourceType |
DataSource 的类型。 目前,唯一可能的值为 Provider。 |
DataSourceVariablesOverrideBehaviorType |
数据源编辑 varaible 替代行为类型。 例如禁止或允许。 |
DataType |
描述列中包含的数据类型。 |
DataViewType |
确定要选择哪些分区来针对模型运行查询。 |
DateTimeRelationshipBehavior |
联接两个日期时间列时,指示是联接日期和时间部件还是仅联接日期部分。 |
DirectLakeBehavior |
Direct Lake 模型的回退行为。 |
EncodingHintType |
用于建议列是否应使用哈希编码的编码提示。 |
ExpressionKind |
指示查询表达式的方言。 |
ExtendedPropertyType |
扩展属性中存储的值类型的可能值的枚举。 |
HierarchyHideMembersType |
隐藏成员可以启用不均衡/不平衡层次结构。 |
ImpersonationMode |
确定在数据导入或刷新期间如何获取与数据源的模拟连接凭据。 |
MetadataPermission |
对元数据对象定义的数据的访问控制。 |
ModelPermission |
可用于 Role 对象的可能模型权限的枚举。 |
ModeType |
定义使数据在分区中可用的方法。 |
ObjectState |
对象状态的可能值的枚举。 |
ObjectType |
表格模型或数据库中逻辑元数据对象的枚举。 如果还不知道该类型是什么,可以使用 ObjectType 返回类型。 |
PartitionSourceType |
分区源的可能值的枚举。 |
PowerBIDataSourceVersion |
Power BI 服务中的 DataSource 格式版本。 |
RefreshGranularityType |
指定用于自动分区的刷新策略的粒度 |
RefreshPolicyBehavior |
有关刷新中受刷新策略管理的对象的行为。 |
RefreshPolicyMode |
刷新策略的模式。 |
RefreshPolicyType |
指定表的刷新策略类型 |
RefreshType |
刷新类型的可能值的枚举。 |
RelationshipEndCardinality |
在表关系两侧定义基数的可能值的枚举。 |
RelationshipType |
关系的类型。 目前,唯一可能的值为 SingleColumn。 |
RoleMemberType |
指示安全角色的特定成员是单个用户还是用户组,还是自动检测到该成员。 |
SaveFlags |
可用于控制 SaveChanges 操作行为的高级选项。 |
SecurityFilteringBehavior |
指示在计算行级别安全表达式时关系如何影响数据的筛选。 枚举定义可能的行为。 |
SummarizationType |
指定要由备用源的列使用的摘要类型。 |
TranslatedProperty |
指定要转换对象的属性。 |
ValueFilterBehaviorType |
确定 SummarizeColumns 的值筛选器行为 |
委托
TraceEventHandler |
表示 Analysis Services 跟踪事件处理程序。 |
TraceStoppedEventHandler |
表示停止跟踪时的事件处理程序。 |