[MS-SSAS-T]: SQL Server Analysis Services Tabular Protocol

Transcription

[MS-SSAS-T]:SQL Server Analysis Services Tabular ProtocolIntellectual Property Rights Notice for Open Specifications Documentation Technical Documentation. Microsoft publishes Open Specifications documentation (“thisdocumentation”) for protocols, file formats, data portability, computer languages, and standardssupport. Additionally, overview documents cover inter-protocol relationships and interactions.Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any otherterms that are contained in the terms of use for the Microsoft website that hosts thisdocumentation, you can make copies of it in order to develop implementations of the technologiesthat are described in this documentation and can distribute portions of it in your implementationsthat use these technologies or in your documentation as necessary to properly document theimplementation. You can also distribute in your implementation, with or without modification, anyschemas, IDLs, or code samples that are included in the documentation. This permission alsoapplies to any documents that are referenced in the Open Specifications documentation.No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.Patents. Microsoft has patents that might cover your implementations of the technologiesdescribed in the Open Specifications documentation. Neither this notice nor Microsoft's delivery ofthis documentation grants any licenses under those patents or any other Microsoft patents.However, a given Open Specifications document might be covered by the Microsoft OpenSpecifications Promise or the Microsoft Community Promise. If you would prefer a written license,or if the technologies described in this documentation are not covered by the Open SpecificationsPromise or Community Promise, as applicable, patent licenses are available by contactingiplg@microsoft.com.License Programs. To see all of the protocols in scope under a specific license program and theassociated patents, visit the Patent Map.Trademarks. The names of companies and products contained in this documentation might becovered by trademarks or similar intellectual property rights. This notice does not grant anylicenses under those rights. For a list of Microsoft trademarks, visitwww.microsoft.com/trademarks.Fictitious Names. The example companies, organizations, products, domain names, emailaddresses, logos, people, places, and events that are depicted in this documentation are fictitious.No association with any real company, organization, product, domain name, email address, logo,person, place, or event is intended or should be inferred.Reservation of Rights. All other rights are reserved, and this notice does not grant any rights otherthan as specifically described above, whether by implication, estoppel, or otherwise.Tools. The Open Specifications documentation does not require the use of Microsoft programmingtools or programming environments in order for you to develop an implementation. If you have accessto Microsoft programming tools and environments, you are free to take advantage of them. CertainOpen Specifications documents are intended for use in conjunction with publicly available standardsspecifications and network programming art and, as such, assume that the reader either is familiarwith the aforementioned material or has immediate access to it.Support. For questions and support, please contact dochelp@microsoft.com.1 / 295[MS-SSAS-T] - v20200611SQL Server Analysis Services Tabular ProtocolCopyright 2020 Microsoft CorporationRelease: June 11, 2020

Revision SummaryDateRevision HistoryRevision ClassComments5/10/20161.0NewInitial Availability7/14/20162.0MajorSignificantly changed the technical content.8/16/20173.0MajorSignificantly changed the technical content.3/16/20184.0MajorSignificantly changed the technical content.10/16/20195.0MajorSignificantly changed the technical content.12/18/20196.0MajorSignificantly changed the technical content.3/5/20207.0MajorSignificantly changed the technical content.6/11/20208.0MajorSignificantly changed the technical content.2 / 295[MS-SSAS-T] - v20200611SQL Server Analysis Services Tabular ProtocolCopyright 2020 Microsoft CorporationRelease: June 11, 2020

Table of Contents1Introduction . 121.1Glossary . 121.2References . 131.2.1Normative References . 131.2.2Informative References . 141.3Overview . 141.3.1Object Ownership . 161.3.2Object References. 161.4Relationship to Other Protocols . 171.5Prerequisites/Preconditions . 181.6Applicability Statement . 181.7Versioning and Capability Negotiation . 181.7.1Versioning . 181.7.2Capability Negotiation . 181.8Vendor-Extensible Fields . 181.9Standards Assignments. 182Messages . 192.1Transport . 192.2Common Data Types . 192.2.1Namespaces . 192.2.2Elements . 202.2.3Complex Types . 202.2.3.1AffectedObjects . 202.2.4Simple Types . 232.2.5Common Data Structures . 232.2.5.1Model Object . 262.2.5.2DataSource Object . 272.2.5.3Table Object . 292.2.5.4Column Object . 312.2.5.5AttributeHierarchy Object. 432.2.5.6Partition Object. 442.2.5.7Relationship Object . 462.2.5.8Measure Object. 482.2.5.9Hierarchy Object . 502.2.5.10Level Object . 512.2.5.11Annotation Object . 512.2.5.12KPI Object . 532.2.5.13Culture Object . 532.2.5.14ObjectTranslation Object . 542.2.5.15LinguisticMetadata Object . 552.2.5.16Perspective Object . 552.2.5.17PerspectiveTable Object . 562.2.5.18PerspectiveColumn Object . 562.2.5.19PerspectiveHierarchy Object . 562.2.5.20PerspectiveMeasure Object . 572.2.5.21Role Object . 572.2.5.22RoleMembership Object . 582.2.5.23TablePermission Object . 582.2.5.24Variation Object . 592.2.5.25ExtendedProperty Object . 602.2.5.26Expression Object . 612.2.5.27ColumnPermission Object. 612.2.5.28DetailRowsDefinition Object . 622.2.5.29CalculationGroup Object . 633 / 295[MS-SSAS-T] - v20200611SQL Server Analysis Services Tabular ProtocolCopyright 2020 Microsoft CorporationRelease: June 11, 2020

2.2.5.302.2.5.312.2.5.322.2.5.333CalculationItem Object . 63FormatStringDefinition Object. 64QueryGroup Object . 65Common Restrictions for Discover Operations . 65Protocol Details . 673.1Server Details . 673.1.1Abstract Data Model . 673.1.2Timers . 673.1.3Initialization . 673.1.4Higher-Layer Triggered Events . 673.1.5Message Processing Events and Sequencing Rules . 673.1.5.1Discover . 673.1.5.1.1Messages . 673.1.5.1.1.1TMSCHEMA MODEL . 673.1.5.1.1.1.1Request Body. 683.1.5.1.1.1.2Response Body . 683.1.5.1.1.1.2.1Columns . 683.1.5.1.1.1.2.2Additional Restrictions . 693.1.5.1.1.2TMSCHEMA DATA SOURCES . 693.1.5.1.1.2.1Request Body. 693.1.5.1.1.2.2Response Body . 693.1.5.1.1.2.2.1Columns . 693.1.5.1.1.2.2.2Additional Restrictions . 713.1.5.1.1.3TMSCHEMA TABLES . 713.1.5.1.1.3.1Request Body. 713.1.5.1.1.3.2Response Body . 713.1.5.1.1.3.2.1Columns . 713.1.5.1.1.3.2.2Additional Restrictions . 723.1.5.1.1.4TMSCHEMA COLUMNS . 733.1.5.1.1.4.1Request Body. 733.1.5.1.1.4.2Response Body . 733.1.5.1.1.4.2.1Columns . 733.1.5.1.1.4.2.2Additional Restrictions . 753.1.5.1.1.5TMSCHEMA ATTRIBUTE HIERARCHIES . 763.1.5.1.1.5.1Request Body. 763.1.5.1.1.5.2Response Body . 763.1.5.1.1.5.2.1Columns . 763.1.5.1.1.5.2.2Additional Restrictions . 773.1.5.1.1.6TMSCHEMA PARTITIONS . 773.1.5.1.1.6.1Request Body. 773.1.5.1.1.6.2Response Body . 773.1.5.1.1.6.2.1Columns . 773.1.5.1.1.6.2.2Additional Restrictions . 793.1.5.1.1.7TMSCHEMA RELATIONSHIPS . 793.1.5.1.1.7.1Request Body. 793.1.5.1.1.7.2Response Body . 793.1.5.1.1.7.2.1Columns . 793.1.5.1.1.7.2.2Additional Restrictions . 813.1.5.1.1.8TMSCHEMA MEASURES . 813.1.5.1.1.8.1Request Body. 813.1.5.1.1.8.2Response Body . 813.1.5.1.1.8.2.1Columns . 813.1.5.1.1.8.2.2Additional Restrictions . 833.1.5.1.1.9TMSCHEMA HIERARCHIES . 833.1.5.1.1.9.1Request Body. 833.1.5.1.1.9.2Response Body . 833.1.5.1.1.9.2.1Columns . 834 / 295[MS-SSAS-T] - v20200611SQL Server Analysis Services Tabular ProtocolCopyright 2020 Microsoft CorporationRelease: June 11, 2020

3.1.5.1.1.9.2.2Additional Restrictions . 843.1.5.1.1.10TMSCHEMA LEVELS . 843.1.5.1.1.10.1Request Body. 843.1.5.1.1.10.2Response Body . 843.1.5.1.1.10.2.1Columns . 853.1.5.1.1.10.2.2Additional Restrictions . 853.1.5.1.1.11TMSCHEMA ANNOTATIONS. 853.1.5.1.1.11.1Request Body. 863.1.5.1.1.11.2Response Body . 863.1.5.1.1.11.2.1Columns . 863.1.5.1.1.11.2.2Additional Restrictions . 863.1.5.1.1.12TMSCHEMA KPIS . 873.1.5.1.1.12.1Request Body. 873.1.5.1.1.12.2Response Body . 873.1.5.1.1.12.2.1Columns . 873.1.5.1.1.12.2.2Additional Restrictions . 883.1.5.1.1.13TMSCHEMA CULTURES . 883.1.5.1.1.13.1Request Body. 883.1.5.1.1.13.2Response Body . 883.1.5.1.1.13.2.1Columns . 893.1.5.1.1.13.2.2Additional Restrictions . 893.1.5.1.1.14TMSCHEMA OBJECT TRANSLATIONS . 903.1.5.1.1.14.1Request Body. 903.1.5.1.1.14.2Response Body . 903.1.5.1.1.14.2.1Columns . 903.1.5.1.1.14.2.2Additional Restrictions . 913.1.5.1.1.15TMSCHEMA LINGUISTIC METADATA . 913.1.5.1.1.15.1Request Body. 913.1.5.1.1.15.2Response Body . 913.1.5.1.1.15.2.1Columns . 913.1.5.1.1.15.2.2Additional Restrictions . 923.1.5.1.1.16TMSCHEMA PERSPECTIVES . 923.1.5.1.1.16.1Request Body. 923.1.5.1.1.16.2Response Body . 923.1.5.1.1.16.2.1Columns . 923.1.5.1.1.16.2.2Additional Restrictions . 933.1.5.1.1.17TMSCHEMA PERSPECTIVE TABLES . 933.1.5.1.1.17.1Request Body. 933.1.5.1.1.17.2Response Body . 933.1.5.1.1.17.2.1Columns . 933.1.5.1.1.17.2.2Additional Restrictions . 943.1.5.1.1.18TMSCHEMA PERSPECTIVE COLUMNS . 943.1.5.1.1.18.1Request Body. 943.1.5.1.1.18.2Response Body . 943.1.5.1.1.18.2.1Columns . 953.1.5.1.1.18.2.2Additional Restrictions . 953.1.5.1.1.19TMSCHEMA PERSPECTIVE HIERARCHIES . 953.1.5.1.1.19.1Request Body. 963.1.5.1.1.19.2Response Body . 963.1.5.1.1.19.2.1Columns . 963.1.5.1.1.19.2.2Additional Restrictions . 963.1.5.1.1.20TMSCHEMA PERSPECTIVE MEASURES . 973.1.5.1.1.20.1Request Body. 973.1.5.1.1.20.2Response Body . 973.1.5.1.1.20.2.1Columns . 973.1.5.1.1.20.2.2Additional Restrictions . 973.1.5.1.1.21TMSCHEMA ROLES . 983.1.5.1.1.21.1Request Body. 985 / 295[MS-SSAS-T] - v20200611SQL Server Analysis Services Tabular ProtocolCopyright 2020 Microsoft CorporationRelease: June 11, 2020

3.1.5.1.1.21.2Response Body . 983.1.5.1.1.21.2.1Columns . 983.1.5.1.1.21.2.2Additional Restrictions . 993.1.5.1.1.22TMSCHEMA ROLE MEMBERSHIPS . 993.1.5.1.1.22.1Request Body. 993.1.5.1.1.22.2Response Body . 993.1.5.1.1.22.2.1Columns . 993.1.5.1.1.22.2.2Additional Restrictions .1003.1.5.1.1.23TMSCHEMA TABLE PERMISSIONS .1003.1.5.1.1.23.1Request Body.1003.1.5.1.1.23.2Response Body .1003.1.5.1.1.23.2.1Columns .1003.1.5.1.1.23.2.2Additional Restrictions .1013.1.5.1.1.24TMSCHEMA VARIATIONS .1013.1.5.1.1.24.1Request Body.1023.1.5.1.1.24.2Response Body .1023.1.5.1.1.24.2.1Columns .1023.1.5.1.1.24.2.2Additional Restrictions .1033.1.5.1.1.25TMSCHEMA EXTENDED PROPERTIES .1033.1.5.1.1.25.1Request Body.1033.1.5.1.1.25.2Response Body .1033.1.5.1.1.25.2.1Columns .1033.1.5.1.1.25.2.2Additional Restrictions .1043.1.5.1.1.26TMSCHEMA EXPRESSIONS .1043.1.5.1.1.26.1Request Body.1043.1.5.1.1.26.2Response Body .1043.1.5.1.1.26.2.1Columns .1043.1.5.1.1.26.2.2Additional Restrictions .1053.1.5.1.1.27TMSCHEMA COLUMN PERMISSIONS .1053.1.5.1.1.27.1Request Body.1053.1.5.1.1.27.2Response Body .1053.1.5.1.1.27.2.1Columns .1053.1.5.1.1.27.2.2Additional Restrictions .1063.1.5.1.1.28TMSCHEMA DETAIL ROWS DEFINITIONS .1063.1.5.1.1.28.1Request Body.1063.1.5.1.1.28.2Response Body .1073.1.5.1.1.28.2.1Columns .1073.1.5.1.1.28.2.2Additional Restrictions .1073.1.5.1.1.29TMSCHEMA CALCULATION GROUPS .1083.1.5.1.1.29.1Request Body.1083.1.5.1.1.29.2Response Body .1083.1.5.1.1.29.2.1Columns .1083.1.5.1.1.29.2.2Additional Restrictions .1093.1.5.1.1.30TMSCHEMA CALCULATION ITEMS .1093.1.5.1.1.30.1Request Body.1093.1.5.1.1.30.2Response Body .1093.1.5.1.1.30.2.1Columns .1093.1.5.1.1.30.2.2Additional Restrictions .1103.1.5.1.1.31TMSCHEMA FORMAT STRING DEFINITIONS .1103.1.5.1.1.31.1Request Body.1103.1.5.1.1.31.2Response Body .1103.1.5.1.1.31.2.1Columns .1103.1.5.1.1.31.2.2Additional Restrictions .1113.1.5.1.1.32TMSCHEMA QUERY GROUPS .1113.1.5.1.1.32.1Request Body.1123.1.5.1.1.32.2Response Body .1123.1.5.1.1.32.2.1Columns .1123.1.5.1.1.32.2.2Additional Restrictions .1126 / 295[MS-SSAS-T] - v20200611SQL Server Analysis Services Tabular ProtocolCopyright 2020 Microsoft CorporationRelease: June 11, 2020

3.1.5.2Execute .1133.1.5.2.1XMLA-Based Tabular Metadata Commands .1133.1.5.2.1.1Create Tabular Metadata .1163.1.5.2.1.1.1Request .1163.1.5.2.1.1.1.1Create DataSources .1163.1.5.2.1.1.1.2Create Tables .1173.1.5.2.1.1.1.3Create Columns .1183.1.5.2.1.1.1.4Create Partitions .1203.1.5.2.1.1.1.5Create Relationships .1213.1.5.2.1.1.1.6Create Measures .1223.1.5.2.1.1.1.7Create Hierarchies .1233.1.5.2.1.1.1.8Create Levels .1243.1.5.2.1.1.1.9Create Annotations .1253.1.5.2.1.1.1.10Create Kpis .1273.1.5.2.1.1.1.11Create Cultures .1283.1.5.2.1.1.1.12Create ObjectTranslations .1293.1.5.2.1.1.1.13Create LinguisticMetadata .1303.1.5.2.1.1.1.14Create Perspectives.1313.1.5.2.1.1.1.15Create PerspectiveTables .1313.1.5.2.1.1.1.16Create PerspectiveColumns .1323.1.5.2.1.1.1.17Create PerspectiveHierarchies .1333.1.5.2.1.1.1.18Create PerspectiveMeasures .1343.1.5.2.1.1.1.19Create Roles .1343.1.5.2.1.1.1.20Create RoleMemberships .1353.1.5.2.1.1.1.21Cr

[MS-SSAS-T]: SQL Server Analysis Services Tabular Protocol . tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and envi