关于 te2-cli
这是一份使用仅限 Windows 的 Tabular Editor 2 命令行工具处理表格模型的技能指南,面向维护现有工作流的用户。内容涵盖本地与远程模型、脚本、检查和部署。
主要功能
- 01加载 BIM、TMDL 和 PBIP 模型
- 02运行内联或文件形式的 C# 脚本
- 03将模型部署到 XMLA 端点
- 04导出为 BIM、TMDL 或文件夹格式
- 05运行 BPA 和架构检查
适用场景
- 01在 Windows CI/CD 中自动部署模型
- 02通过脚本修改模型并保存结果
- 03使用 BPA 规则检查模型
- 04从 XMLA 服务导出模型
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ data-goblin/ power-bi-agentic-development --skill te2-cli安装后在 Claude Code 中输入/te2-cli确认已加载。
附带文件references/auth-and-cicd.md
详细介绍
Tabular Editor 2 命令行界面
Tabular Editor 2(TE2)的命令行界面。本技能介绍 TabularEditor.exe 可执行文件;TE3 有自己的 CLI,是一款独立产品。
说明
TE2 CLI(
TabularEditor.exe)仍受支持且稳定,对于现有的 Windows CI/CD 流水线仍是可靠的选择。与较新的跨平台 Tabular Editor CLI(te)相比,它现在被视为较旧的版本;te基于 TE3 构建,目前处于预览阶段,预计持续到 2026 年第 4 季度。有关te命令集以及逐项标志迁移指南,请参阅te-cli技能。可从 Tabular Editor CLI 下载页面下载te预览版二进制文件。
安装
Tabular Editor 2(免费)
- 下载:https://github.com/TabularEditor/TabularEditor/releases
- 解压到首选位置,或使用 Chocolatey:
choco install tabulareditor2
可执行文件
TabularEditor.exe —— 免费,仅适用于 Windows。对于 Mac/Linux,请通过 Windows 虚拟机或容器运行。
连接来源
本地文件
# model.bim (JSON format)
TabularEditor.exe Model.bim
# TMDL folder
TabularEditor.exe definition/
# PBIP project
TabularEditor.exe MyReport.pbip
远程 XMLA 终结点
# Analysis Services
TabularEditor.exe "localhost\tabular" "AdventureWorks"
# Power BI Premium/Fabric
TabularEditor.exe "powerbi://api.powerbi.com/v1.0/myorg/WorkspaceName" "ModelName"
Power BI Desktop
# Auto-detect running instance
TabularEditor.exe localhost:PORT DatabaseName
注意:可在 PBIDesktop 诊断文件中查找端口,或使用 DAX Studio 等工具。
命令行参考
基本语法
TabularEditor.exe <source> [options]
脚本执行
# Inline C# script
TabularEditor.exe Model.bim -S "Info(Model.Name);"
# Script file
TabularEditor.exe Model.bim -S script.csx
# Multiple scripts (executed in order)
TabularEditor.exe Model.bim -S script1.csx -S script2.csx
部署
# Deploy to XMLA endpoint
TabularEditor.exe Model.bim -D "server" "database"
# Deploy with options
TabularEditor.exe Model.bim -D "server" "database" -O -C -P -R -M -E -V -W
部署选项
| 标志 | 长格式 | 说明 |
|---|---|---|
-O | -OVERWRITE | 覆盖现有数据库 |
-C | -CONNECTIONS | 部署/覆盖数据源(支持连接字符串占位符替换) |
-P | -PARTITIONS | 部署/覆盖现有表分区 |
-R | -ROLES | 部署角色 |
-M | -MEMBERS | 部署角色成员 |
-S | -SHARED | 部署共享表达式(在 -D 上下文中;注意:在 -D 之外,-S 也表示脚本) |
-E | -ERR | 如果部署后 AS 返回错误消息,则返回非零退出代码 |
-V | -VSTS | 输出 Azure DevOps 日志命令 |
-W | -WARN | 对未处理的对象输出警告 |
-F | -FULL | 完整部署(等同于 -O -C -P -S -R -M) |
-X | -XMLA | 生成 XMLA/TMSL 脚本,而非执行部署 |
-L | -LOGIN | 部署时禁用集成安全性 |
-Y | -SKIPPOLICY | 跳过增量刷新策略分区 |
保存输出
# Save to model.bim
TabularEditor.exe Model.bim -S script.csx -B Output.bim
# Save to TMDL folder
TabularEditor.exe Model.bim -S script.csx -TMDL output/
# Save to legacy folder structure
TabularEditor.exe Model.bim -S script.csx -F output/
最佳实践分析器
# Run BPA rules
TabularEditor.exe Model.bim -A rules.json
# Run BPA with Azure DevOps logging output
TabularEditor.exe Model.bim -A rules.json -V
# Run BPA with GitHub Actions logging output
TabularEditor.exe Model.bim -A rules.json -G
# Analyze excluding rules embedded in model annotations
TabularEditor.exe Model.bim -AX rules.json
架构检查
# Validate data source schemas against the model
TabularEditor.exe Model.bim -SC
常见操作
1. 将本地模型部署到服务
TabularEditor.exe Model.bim ^
-D "powerbi://api.powerbi.com/v1.0/myorg/Workspace" "SemanticModel" ^
-O -C
2. 运行脚本并保存
TabularEditor.exe Model.bim -S format-dax.csx -B Model.bim
3. 运行 BPA 分析
TabularEditor.exe Model.bim ^
-A https://raw.githubusercontent.com/microsoft/Analysis-Services/master/BestPracticeRules/BPARules.json ^
-V
4. 刷新模型数据
TabularEditor.exe "server" "database" ^
-S "Model.RequestRefresh(RefreshType.Full);" ^
-D "server" "database"
5. 从服务导出模型
TabularEditor.exe "powerbi://api.powerbi.com/v1.0/myorg/Workspace" "Model" ^
-TMDL output/definition
身份验证
有关身份验证方法(Windows、服务主体、交互式)和 CI/CD 集成(Azure DevOps、GitHub Actions),请参阅 references/auth-and-cicd.md。
退出代码
| 代码 | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 存在任何错误级输出(脚本错误、部署失败、严重性 >= 3 的 BPA 违规) |
文件格式
输入格式
model.bim- 表格 JSON(旧版)definition/- TMDL 文件夹(新版)*.pbip- Power BI 项目(TE3)
输出格式
| 标志 | 格式 | 说明 |
|---|---|---|
-B | .bim | 表格 JSON |
-TMDL | 文件夹 | TMDL |
-F | 文件夹 | 旧版文件夹结构 |
故障排除
有关常见错误(找不到数据库、身份验证失败、脚本执行失败),请参阅 references/auth-and-cicd.md。
速查卡
+---------------------------------------------------------+
| TABULAR EDITOR CLI QUICK REFERENCE |
+---------------------------------------------------------+
| SOURCES |
| Model.bim Local JSON model |
| definition/ TMDL folder |
| "server" "db" XMLA connection |
+---------------------------------------------------------+
| SCRIPTS |
| -S "code" Inline C# script |
| -S file.csx Script file |
+---------------------------------------------------------+
| DEPLOYMENT |
| -D "server" "db" Deploy to target |
| -O Overwrite existing |
| -C Create if not exists |
+---------------------------------------------------------+
| OUTPUT |
| -B output.bim Save as JSON |
| -TMDL folder/ Save as TMDL |
+---------------------------------------------------------+
| BPA |
| -A rules.json Run BPA analysis |
| -G results.sarif Output BPA results |
+---------------------------------------------------------+
参考资料
要获取最新的 XMLA 和部署文档,请搜索 https://learn.microsoft.com 并抓取相关页面。根据用户的请求进行搜索,并按需执行多次搜索,以确保在继续操作前获得足够的上下文。