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 对象。 它是表对象的子级。 |
CalculatedColumn |
表示基于还包含 DataColumn 和 RowNumberColumn 的表中的 DAX 表达式的列。 CalculatedColumn 还可以添加到已计算的表。 |
CalculatedPartitionSource |
表示 CalculatedTable 对象的一个分区。 |
CalculatedTableColumn |
表示基于 DAX 表达式的表中的列。 CalculatedTableColumn 的集合,位于绑定源类型为 CalculatedPartitionSource 的分区的表对象之下,会生成已计算的表。 |
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 |
表示用户区域性。 它是模型对象的子级,用来转换字符串和格式化值。 |
CultureAnnotationCollection |
Annotation 对象的集合。 |
CultureCollection |
Culture 对象的集合。 |
CultureExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
CustomJsonProperty<TOwner> |
自定义属性的基类,将 JSON 对象表示为不同属性的集合。 |
DataAccessOptions |
Model.DataAccessOptions 属性的值 |
Database |
指定一个 Analysis Services 表格或多维数据库。 此类不能被继承。 服务器模式和模型类型将确定是否可以随后创建或修改模型树。 具体而言,如果调用表格数据库,则仅能在兼容级别 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 |
表示一个 Partition,它由对来自基础 DataSource/Provider 的对象的引用提供支持。 |
ExtendedProperty |
用于通过 TOM 和 CSDL 以名称/值对形式传递对象特定信息以供客户端应用程序使用的架构扩展。 如果将类型设置为 JSON,分析服务将验证 JSON 的格式是否正确。 ExtendedProperty 被定义为模型中的逻辑元数据对象的子级。 |
ExternalModelRoleMember |
仅限内部使用。 |
FormatStringDefinition |
表示 FormatStringDefinition 对象。 它是 Measure 或 CalculationItem 的子级。 |
GroupByColumn |
列对象的扩展,该扩展包含分组依据的列的列表 |
GroupByColumnCollection |
GroupByColumn 对象的集合。 |
Hierarchy |
表示为客户端应用程序提供逻辑层次结构深化路径的集合的级别。 它是表对象的子级。 |
HierarchyAnnotationCollection |
Annotation 对象的集合。 |
HierarchyChangedPropertyCollection |
ChangedProperty 对象的集合。 |
HierarchyCollection |
Hierarchy 对象的集合。 |
HierarchyExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
InferredPartitionSource |
表示将通过执行系统生成的查询来填充其数据的分区。 |
JsonExtendedProperty |
表示具有 JSON 值的 ExtendedProperty。 |
JsonScripter |
用于将表格 aatabase 或元数据对象编写成 JSON 脚本的帮助程序类。 |
JsonSerializer |
对 JSON 的内存中对象树的双向转换。 JSON 用于对兼容级别 1200 或更高级别下的表格模型或表格数据库的对象进行定义。 |
KPI |
表示“关键绩效指标”对象。 它是度量值对象的子级。 |
KPIAnnotationCollection |
Annotation 对象的集合。 |
KPIExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
Level |
表示为客户端应用程序提供逻辑层次结构深化路径的层次结构中的级别。 它是层次结构对象的子级。 级别基于列中的值。 |
LevelAnnotationCollection |
Annotation 对象的集合。 |
LevelChangedPropertyCollection |
ChangedProperty 对象的集合。 |
LevelCollection |
级别对象的集合。 |
LevelExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
LinguisticMetadata |
保留表格模型的同义词信息。 它是区域性对象的子级。 |
LinguisticMetadataAnnotationCollection |
Annotation 对象的集合。 |
LinguisticMetadataExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
Measure |
代表基于表达式计算的值。 它是表对象的子级。 |
MeasureAnnotationCollection |
Annotation 对象的集合。 |
MeasureChangedPropertyCollection |
ChangedProperty 对象的集合。 |
MeasureCollection |
Measure 对象的集合。 |
MeasureExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
MetadataObject |
表格对象的类层次结构中的基类。 |
MetadataObjectCollection<T,P> |
表示元数据对象集合。 |
Model |
在兼容级别 1200 或更高级别下创建的表格模型。 |
ModelAnnotationCollection |
Annotation 对象的集合。 |
ModelExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
ModelOperationResult |
表示在 Model 上进行操作的结果(如 Sync(),SaveChanges()) |
ModelRole |
定义为其应用安全规则的一组用户主体。 它是模型对象的子级。 |
ModelRoleAnnotationCollection |
Annotation 对象的集合。 |
ModelRoleCollection |
ModelRole 对象的集合。 |
ModelRoleExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
ModelRoleMember |
定义一个属于该角色的用户主体。 它是角色对象的子级。 |
ModelRoleMemberAnnotationCollection |
Annotation 对象的集合。 |
ModelRoleMemberCollection |
ModelRoleMember 对象的集合。 |
ModelRoleMemberExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
MPartitionSource |
表示由 M 表达式支持的分区。 |
NamedExpression |
可由一个或多个分区使用的命名表达式。 |
NamedExpressionAnnotationCollection |
Annotation 对象的集合。 |
NamedExpressionCollection |
NamedExpression 对象的集合。 |
NamedExpressionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
NamedMetadataObject |
按名称表示表格元数据对象。 |
NamedMetadataObjectCollection<T,P> |
命名元数据对象的集合。 |
ObjectImpact |
表示对模型树的修改,它来自一个或多个用户操作,如添加新对象、删除现有对象或更改对象属性。 |
ObjectReference |
提供针对某个对象的链接。 此类不能被继承。 |
ObjectTranslation |
表示对区域性父对象的元数据属性的转换。 有些属性可以转换,如名称和对元数据对象的描述。 如果它们未被转换,则使用主对象上指定的属性。 ObjectTranslation 对象对其所转换的对象具有一种弱类型引用。 |
ObjectTranslationCollection |
ObjectTranslation 对象的集合。 |
OutOfSyncException |
提供不同步错误。 |
ParquetPartitionSource |
表示将通过执行系统生成的查询来填充其数据的分区。 |
Partition |
表示表中的分区。 分区定义对返回 Table 行集的外部数据源的查询。 |
PartitionAnnotationCollection |
Annotation 对象的集合。 |
PartitionCollection |
Partition 对象的集合。 |
PartitionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PartitionSource |
所有分区源的基类:QueryPartitionSource、CalculatedPartitionSource、MPartitionSource、EntityPartitionSource。 |
Perspective |
对模型定义逻辑视图,且该逻辑视图为模型对象的子级。 它允许隐藏表、列、度量值和层次结构,以便最终用户可以查看大型数据模型的较小子集。 |
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 |
包括进入透视的表。 它是透视对象的子级。 PerspectiveColumns、PerspectiveMeasures 和 PerspectiveHierarchies 子对象允许对透视中表的可见部分进行自定义。 |
PerspectiveTableAnnotationCollection |
Annotation 对象的集合。 |
PerspectiveTableCollection |
PerspectiveTable 对象的集合。 |
PerspectiveTableExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
PolicyRangePartitionSource |
表示基于范围刷新策略的分区 |
PrivacyClass |
DataSource.Credential.PrivacySetting 的常量,此设置定义了如何在生成的查询中将数据源数据共享给其他数据源。 |
PropertyChangeEntry |
表示有关元数据对象属性的修改的信息。 |
ProviderDataSource |
表示使用连接字符串用于连接的数据源。 |
QueryGroup |
表示 QueryGroup 对象。 与 Partition 或 NamedExpression 对象关联。 |
QueryGroupAnnotationCollection |
Annotation 对象的集合。 |
QueryGroupCollection |
QueryGroup 对象的集合。 |
QueryPartitionSource |
提供一个外部数据源的查询,采用本机查询语言,该数据源用于检索单个分区的数据的一个切片。 |
RefreshPolicy |
表示抽象的 RefreshPolicy 对象。 它是表对象的子级。 |
RefreshPolicyAnnotationCollection |
Annotation 对象的集合。 |
RefreshPolicyExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
RelatedColumnDetails |
列对象的扩展,该扩展包含列的分组依据的列列表 |
Relationship |
表示两个表对象之间的逻辑关系。 它是模型对象的子级。 |
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。 如果 Table 是已计算的表,则行基于 Partition 对象或 CalculatedPartitionSource。 |
TableAnnotationCollection |
Annotation 对象的集合。 |
TableChangedPropertyCollection |
ChangedProperty 对象的集合。 |
TableCollection |
Table 对象的集合。 |
TableExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
TablePermission |
在表上定义角色的安全性规则。 它是角色对象的子级。 |
TablePermissionAnnotationCollection |
Annotation 对象的集合。 |
TablePermissionCollection |
TablePermission 对象的集合。 |
TablePermissionExtendedPropertyCollection |
ExtendedProperty 对象的集合。 |
TmdlSerializer |
重要提示:TMDL 仍处于预览状态,API 图面在正式发布之前可能仍有待修改!
|
TomException |
表示发生表格对象模型错误或警告时引发的常规异常。 |
TomInternalException |
表示其来源不确定或发生于堆践较低层的内部错误。 |
TomValidationException |
表示正在阻止完成当前操作的元数据对象状态中的不一致。 |
Trace |
提供了一种机制来存储可供以后查看或重播的事件日志。 此类不能被继承。 |
TraceCollection |
表示 Trace 对象集合。 此类不能被继承。 |
TraceColumnCollection |
表示 TraceColumn 对象集合。 此类不能被继承。 |
TraceEvent |
表示跟踪事件。 |
TraceEventArgs |
定义与跟踪事件关联的标识符和值。 此类不能被继承。 |
TraceEventCollection |
表示 TraceEvent 对象集合。 此类不能被继承。 |
TraceStoppedEventArgs |
表示跟踪已停止事件。 |
Utils |
主要用于名称验证和语法检查的常规用途实用工具。 |
ValidationError |
表示在元数据对象树的验证过程中发现的错误。 |
ValidationResult |
表示元数据对象树的一致性验证结果。 |
Variation |
Variation 对象。 |
VariationAnnotationCollection |
Annotation 对象的集合。 |
VariationCollection |
Variation 对象的集合。 |
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 |
数据源编辑 varaibles 替代行为类型。 例如,“禁止”或“允许”。 |
DataType |
描述列中包含的数据类型。 |
DataViewType |
确定要选择哪些分区来针对模型运行查询。 |
DateTimeRelationshipBehavior |
在联接两个日期时间列时,指示是联接日期和时间部分还是仅联接日期部分。 |
DirectLakeBehavior |
Direct Lake模型的回退行为。 |
EncodingHintType |
建议列是否应使用哈希编码的编码提示。 |
ExpressionKind |
指示查询表达式的方言。 |
ExtendedPropertyType |
扩展属性中所存储值类型的可能值枚举。 |
HierarchyHideMembersType |
可以通过隐藏成员启用不规则/非均衡层次结构。 |
ImpersonationMode |
确定在数据导入或刷新过程中为数据源的模拟连接获取凭据的方式。 |
MetadataPermission |
对元数据对象定义的数据的访问控制。 |
ModelPermission |
可以在角色对象中使用可能的模型权限的枚举。 |
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 |
表示跟踪停止时的事件处理程序。 |