uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
uip pm 提取、uip pm 转换
用于使用“uip pm 提取”和“uip pm 转换”触发和检查 Process Mining 数据提取和 dbt 转换的语法和选项。
作为uip pm工具的一部分。ingestions 将上传的数据文件加载到流程应用程序中; transformations 管理并运行 dbt SQL 模型,这些模型将提取的数据重新调整为应用程序的可查询表格。两者都支持在运行完成之前阻止--wait — 请参阅父页面上的概念。
大纲
uip pm ingestions create <app-id> [--stage dev|published] [--file-format csv|tsv] [--field-delimiter <char>] [--quote-character <char>] [--encoding utf-8|iso-8859-1] [--wait] [--timeout <s>] [--poll-interval <s>]
uip pm ingestions cancel <app-id> <ingestion-id> [--stage dev|published]
uip pm ingestions logs <app-id> <ingestion-id> [--stage dev|published] [--limit <n>] [--offset <n>]
uip pm transformations list <app-id> [--stage dev|published]
uip pm transformations get <app-id> <path> [--stage dev|published] [--destination <file>]
uip pm transformations create <app-id> <path> --file <local-file> [--stage dev|published]
uip pm transformations update <app-id> <path> --file <local-file> --etag <etag> [--stage dev|published]
uip pm transformations run <app-id> [--model <path>] [--wait] [--timeout <s>] [--poll-interval <s>]
uip pm transformations apply <app-id> [--stage dev|published] [--wait] [--timeout <s>] [--poll-interval <s>]
uip pm transformations cancel <app-id>
uip pm transformations status <app-id>
uip pm transformations logs <app-id>
uip pm ingestions create <app-id> [--stage dev|published] [--file-format csv|tsv] [--field-delimiter <char>] [--quote-character <char>] [--encoding utf-8|iso-8859-1] [--wait] [--timeout <s>] [--poll-interval <s>]
uip pm ingestions cancel <app-id> <ingestion-id> [--stage dev|published]
uip pm ingestions logs <app-id> <ingestion-id> [--stage dev|published] [--limit <n>] [--offset <n>]
uip pm transformations list <app-id> [--stage dev|published]
uip pm transformations get <app-id> <path> [--stage dev|published] [--destination <file>]
uip pm transformations create <app-id> <path> --file <local-file> [--stage dev|published]
uip pm transformations update <app-id> <path> --file <local-file> --etag <etag> [--stage dev|published]
uip pm transformations run <app-id> [--model <path>] [--wait] [--timeout <s>] [--poll-interval <s>]
uip pm transformations apply <app-id> [--stage dev|published] [--wait] [--timeout <s>] [--poll-interval <s>]
uip pm transformations cancel <app-id>
uip pm transformations status <app-id>
uip pm transformations logs <app-id>
uip pm 提取创建
触发对已上传数据文件的提取。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<app-id> | 是 | 流程应用程序 ID。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--stage <stage> | dev | published | dev | 要提取到的应用程序阶段。 |
--file-format <format> | csv | tsv | csv | 数据文件格式。 |
--field-delimiter <char> | 字符串 | , | 数据文件中的字段分隔符。 |
--quote-character <char> | 字符串 | " | 包含字段的引号字符。 |
--encoding <encoding> | utf-8 | iso-8859-1 | utf-8 | 文件编码。 |
--wait | 标记 | 关闭 | 阻止,直到提取达到最终状态;失败时退出非零值。 |
--timeout <seconds> | 整数 | 1800 | 设置了 --wait 时等待的最大秒数。 |
--poll-interval <seconds> | 整数 | 5 | 设置了 --wait 时状态轮询之间的秒数。 |
示例
uip pm ingestions create 9c46289e --file-format csv --encoding iso-8859-1
uip pm ingestions create 9c46289e --file-format csv --encoding iso-8859-1
数据形状(--输出 json)
没有--wait :
{ "Code": "PmIngestionsCreate", "Data": { "Status": "Accepted", "Message": "Ingestion started. Poll 'uip pm apps list' (LastIngestion) for progress." } }
{ "Code": "PmIngestionsCreate", "Data": { "Status": "Accepted", "Message": "Ingestion started. Poll 'uip pm apps list' (LastIngestion) for progress." } }
与 --wait 一起:
{ "Code": "PmIngestionsCreate", "Data": { "Status": "SUCCESS", "IngestionId": "1d7e1421" } }
{ "Code": "PmIngestionsCreate", "Data": { "Status": "SUCCESS", "IngestionId": "1d7e1421" } }
如果 --wait 失败,则以非零值退出,并将提取自身的错误日志行(通过 ingestions logs)折叠到失败消息中。
uip pm 提取取消
取消仍在运行的提取。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<app-id> | 是 | 流程应用程序 ID。 |
<ingestion-id> | 是 | 提取 ID(uip pm apps get <app-id> 显示 LastIngestion)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--stage <stage> | dev | published | dev | 运行提取的应用程序阶段。 |
示例
uip pm ingestions cancel 9c46289e 1d7e1421
uip pm ingestions cancel 9c46289e 1d7e1421
数据形状(--输出 json)
{ "Code": "PmIngestionsCancel", "Data": { "AppId": "9c46289e", "IngestionId": "1d7e1421", "Status": "Cancelling" } }
{ "Code": "PmIngestionsCancel", "Data": { "AppId": "9c46289e", "IngestionId": "1d7e1421", "Status": "Cancelling" } }
uip pm 提取日志
获取提取运行的日志。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<app-id> | 是 | 流程应用程序 ID。 |
<ingestion-id> | 是 | 提取 ID。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--stage <stage> | dev | published | dev | 运行提取的应用程序阶段。 |
--limit <number> | 整数 | 100 | 要获取的最大日志条目数(页面大小)。 |
--offset <number> | 整数 | 0 | 在页面之前要跳过的日志条目数。 |
示例
uip pm ingestions logs 9c46289e 1d7e1421 --limit 50 --offset 50
uip pm ingestions logs 9c46289e 1d7e1421 --limit 50 --offset 50
数据形状(--输出 json)
{ "Code": "PmIngestionsLogs", "Data": [{ "Message": "Data run started" }] }
{ "Code": "PmIngestionsLogs", "Data": [{ "Message": "Data run started" }] }
uip pm 转换列表
列出流程应用程序的转换(dbt 模型)文件。
| 名称/选项 | 必填 | 用途 |
|---|---|---|
<app-id> | 是 | 流程应用程序 ID。 |
--stage <stage> | 否 | dev | published,默认为 dev。 |
{ "Code": "PmTransformationsList", "Data": {} }
{ "Code": "PmTransformationsList", "Data": {} }
uip pm 转换获取
获取转换文件的内容及其 ETag — update 需要将其用作 --etag。
| 名称/选项 | 必填 | 用途 |
|---|---|---|
<app-id> | 是 | 流程应用程序 ID。 |
<path> | 是 | 转换文件路径,例如models/Cases.sql。 |
--stage <stage> | 否 | dev | published,默认为 dev。 |
--destination <local-file> | 否 | 将内容写入此本地文件,而非输出信封。 |
{ "Code": "PmTransformationsGet", "Data": { "Path": "models/Cases.sql", "ETag": "W/\"...\"", "Content": "select ..." } }
{ "Code": "PmTransformationsGet", "Data": { "Path": "models/Cases.sql", "ETag": "W/\"...\"", "Content": "select ..." } }
uip pm 转换创建
根据本地文件创建新的转换文件。使用 update 修改现有路径 — 如果路径已存在,则修改失败。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--file <local-file> | 路径 | 是 | 包含新内容的本地文件。 |
--stage <stage> | dev | published | 否 | 默认 dev。 |
uip pm transformations create 9c46289e models/Workload.sql --file ./Workload.sql
uip pm transformations create 9c46289e models/Workload.sql --file ./Workload.sql
{ "Code": "PmTransformationsCreate", "Data": { "Path": "models/Workload.sql", "ETag": "W/\"...\"" } }
{ "Code": "PmTransformationsCreate", "Data": { "Path": "models/Workload.sql", "ETag": "W/\"...\"" } }
uip pm 转换更新
从本地文件更新转换文件(ETag 安全)。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--file <local-file> | 路径 | 是 | 包含新内容的本地文件。 |
--etag <etag> | 字符串 | 是 | 此编辑所基于的文件的 ETag,来自 transformations get。 |
--stage <stage> | dev | published | 否 | 默认 dev。 |
uip pm transformations update 9c46289e models/Cases.sql --file ./Cases.sql --etag 'W/"639204059477096903"'
uip pm transformations update 9c46289e models/Cases.sql --file ./Cases.sql --etag 'W/"639204059477096903"'
{ "Code": "PmTransformationsUpdate", "Data": { "Path": "models/Cases.sql", "ETag": "W/\"639209312397638135\"" } }
{ "Code": "PmTransformationsUpdate", "Data": { "Path": "models/Cases.sql", "ETag": "W/\"639209312397638135\"" } }
过时的 --etag 将因冲突而失败 — 通过 transformations get 重新读取,重做编辑,然后重试。
uip pm 转换运行
在开发阶段运行 dbt 转换 — 仅构建已更改/依赖的模型。使用 apply 强制对已提取的数据完全重新运行。
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--stage <stage> | dev | dev | 仅支持 dev。 |
--model <model-path> | 路径 | — | 仅运行此模型(例如models/Cases.sql)及其依赖项。省略运行所有内容。 |
--wait | 标记 | 关闭 | 阻止,直到构建达到最终状态;失败时退出非零值(自动打印 dbt 错误)。 |
--timeout <seconds> | 整数 | 1800 | 等待的最大秒数。 |
--poll-interval <seconds> | 整数 | 5 | 轮询之间的秒数。 |
示例
uip pm transformations run 9c46289e --model models/Cases.sql
uip pm transformations run 9c46289e --model models/Cases.sql
数据形状(--输出 json)
{ "Code": "PmTransformationsRun", "Data": { "Status": "Accepted", "Message": "Build started. Re-run with --wait to block until it finishes, or poll 'uip pm transformations status 9c46289e'." } }
{ "Code": "PmTransformationsRun", "Data": { "Status": "Accepted", "Message": "Build started. Re-run with --wait to block until it finishes, or poll 'uip pm transformations status 9c46289e'." } }
uip pm 转换取消
取消当前在 dev 上运行的 dbt 构建。
uip pm transformations cancel 9c46289e
uip pm transformations cancel 9c46289e
{ "Code": "PmTransformationsCancel", "Data": { "AppId": "9c46289e", "Status": "Cancelling" } }
{ "Code": "PmTransformationsCancel", "Data": { "AppId": "9c46289e", "Status": "Cancelling" } }
uip pm 转换适用
对已提取的数据重新运行完整的数据转换(与仅构建更改的开发模型的 run 不同)。
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--stage <stage> | dev | published | dev | 应用程序阶段。 |
--wait | 标记 | 关闭 | 阻止直到转换达到终止状态;失败时退出非零值。 |
--timeout <seconds> | 整数 | 1800 | 等待的最大秒数。 |
--poll-interval <seconds> | 整数 | 5 | 轮询之间的秒数。 |
uip pm transformations apply 9c46289e
uip pm transformations apply 9c46289e
{ "Code": "PmTransformationsApply", "Data": { "Status": "Accepted", "Message": "Transform started. Poll 'uip pm apps list' (LastIngestion) for progress." } }
{ "Code": "PmTransformationsApply", "Data": { "Status": "Accepted", "Message": "Transform started. Poll 'uip pm apps list' (LastIngestion) for progress." } }
uip pm 转换状态
获取当前/上一个转换构建的状态。
uip pm transformations status 9c46289e
uip pm transformations status 9c46289e
{ "Code": "PmTransformationsStatus", "Data": {} }
{ "Code": "PmTransformationsStatus", "Data": {} }
uip pm 转换日志
获取当前/上一次转换构建的日志。
uip pm transformations logs 9c46289e
uip pm transformations logs 9c46289e
{ "Code": "PmTransformationsLogs", "Data": {} }
{ "Code": "PmTransformationsLogs", "Data": {} }
相关内容
uip pm— 概述,apps,files。apps model— 需要重新提取或重新转换才能生效的模型/字段/数据映射更改。conformance、deviations和query— 分析结果。