跳转到内容

表、步骤和工作流的文档

在项目中选择表、步骤或工作流,其详细信息面板就会打开。在底部,文档部分会显示 Weave 根据项目已保存的设置编写的相关页面:

  • 对于表,显示写入和读取它的步骤,以及它的列;
  • 对于步骤,显示它的作用及运行位置;
  • 对于工作流,显示按顺序排列的步骤,以及它读取和写入的表。

每次选择该项时都会编写页面,依据的是当时已保存的设置,因此不会过时,也无需手动刷新。不涉及 AI,因此在没有可用 AI 提供方时也能使用。在同一详细信息面板中保存之后(例如新的描述),页面会重新编写。

Weave AI、项目 Weave 选项卡中的聊天,以及通过 MCP 连接的 AI 助手都可以读取同一页面。请参阅面向 AI 助手。

  • 描述:表的备注,以引用形式显示。PlaidCloud 会为步骤创建的表设置备注 Created dynamically,该备注不会显示,因为它没有说明关于表的任何信息。
  • 写入方和读取方:每个步骤按名称列出,并附有步骤类型及其所在的工作流。(已禁用)跟在步骤被禁用的工作流之后,不在任何工作流中表示该步骤不在任何工作流中。如果步骤的表名中包含变量,而该变量可能指向也可能不指向此表,则会附上取决于其变量的值。如果步骤只给出了多个表共用的名称,则会附上例如除非它指的是同名的另外 2 个表中的另一个,仅统计您可以打开的表。表:清空、表:删除或表:就地删除步骤视为写入其更改的表,既读取表又将其写回的步骤会在两处都列出。
  • 此项目中没有步骤读取此表。 表示此项目中没有步骤将其列为源。页面不会检查仪表板、导出、其他项目或项目步骤之外的任何内容。
  • 列:每个列及其类型,如果在列属性中设置了描述,则一并显示。

它的作用为步骤所做的每件事各给出一句话:

步骤 页面的说明
分摊:拆分 从哪个表拆分哪个值、跨哪些列、使用哪个动因列,以及每一份的计算方式,例如“每个 product 的份额等于其 weight 除以同一 cost_center、year 和 month 的 weight 总和。”列名采用源表和动因表所用的名称。会注明步骤的源或动因上的筛选器,并指明它写入的表。
分摊:按维度拆分 从哪个表拆分哪个值、使用哪个动因列,以及它写入的每个表,包括其映射表、路径表和汇总表。
导入 它导入的一个或多个文件,以及导入到的表。
导出 它导出的表,以及写出的文件。
提取:未列出源的 SQL 它运行一条 SQL 查询,以及它写入的表。
表:清空、表:删除、表:就地删除 它清空、删除其表,或从其表中删除行;或者,当它通过搜索或文件夹选取表时,说明它作用于该设置所选取的表。
导入外部项目表 它将另一个项目中的表复制到本项目的表中。
运行另一个工作流的步骤 它运行的工作流及方式:满足条件时、在循环中、作为宏(对其源表的每一行运行一次,并发运行则同时进行),或通过包含它。由变量选择的工作流显示为步骤给出的名称,位于另一个项目中的工作流也据此描述。步骤自身读取的任何表(例如循环所遍历的表)也会列出。
任何其他步骤 它读取的表和写入的表。

页面随后会说明步骤的运行位置:它是以下工作流中的第 3 步,后跟工作流名称,编号与工作流的步骤列表一致;或者说明它不在任何工作流中。

步骤通过变量指定的表以其名称显示,后跟*(由变量指定)*。

  • 步骤:编号与工作流的步骤列表一致,并附有每个步骤的类型及其写入的表,或其运行的工作流。它所包含的工作流的步骤会就地列出,与步骤列表的显示方式相同。
  • 从此工作流之外读取:在此工作流中任何步骤写入之前就被某个步骤读取的表。
  • 写入:工作流的步骤写入的表。

已禁用的步骤会列在步骤中,但不会出现在另外两个列表中。页面会说明这一点,因为已禁用步骤写入的表可能因此被列为从外部读取。工作流的某个步骤所运行的工作流所使用的表,位于该工作流自己的页面上。

要交接项目,例如在合作结束时交给客户,可以一次下载所有页面。在项目窗口中,选择一个项目,然后从操作菜单或右键菜单中选择下载交接包。您需要对该项目及其步骤、工作流和表具有读取权限。

交接包是一个以项目命名的 Markdown 文件,例如 Month End handover.md,在下载时根据已保存的设置编写。它以项目的描述和所含内容的计数开头,然后分为四个部分:

  • 工作流:每个工作流的页面。没有被其他工作流运行的工作流排在最前面,按名称排序,每个工作流之后是它所运行的工作流,按其运行顺序排列。从两处运行的工作流只列出一次。
  • 表:每个表的页面,如上所述,包括其列及列的描述。
  • 指标:每个指标定义的当前版本,用通俗的句子说明:衡量什么、来自哪个表、联接了哪些表、使用哪些行、其实际数和预算行、其期间,以及可以按什么进行细分。由其他指标构建的指标会说明构建方式,例如收入除以订单数。请参阅指标定义。
  • 分摊模型:每条相互衔接的分摊步骤链,包括其终止的一个或多个步骤,以及每个步骤的拆分,按运行顺序排列。不在任何工作流中运行的步骤会被省略。模型以其工作流命名,或以其工作流共用的文件夹命名。如果它没有这样的名称、与另一个模型共用该名称,或取自您的角色所隐藏的内容,则改以其中一个步骤作为标题。分摊模型在交接包之外没有自己的页面。

对于您的角色所隐藏的内容,交接包遵循与单个页面相同的规则。您无法打开的工作流、表或分摊模型会被省略,并在顶部计数,例如*它省略了您无法打开的 2 个工作流和 5 个表。*与单个页面一样,您无法打开的步骤绝不会被指名。

表、步骤或工作流可以对管理者或探索者角色隐藏。页面绝不会指明您的角色所隐藏的任何内容:

  • 您无法打开的步骤会被计数,例如另有 2 个您无法打开的步骤,并在工作流的步骤列表中保留其编号。
  • 您无法打开的表、步骤或工作流,其显示方式与已不存在的相同,例如您无法打开或已不存在的表,因此无法借助页面来查明隐藏的内容是否存在。以这种方式从工作流列表中省略的步骤会被注明,因为其中某个步骤写入的表可能因此被列为从外部读取。步骤中指定的、您无法打开或不存在的表,以步骤给出的名称显示,后跟*(不是您可以打开的表),工作流同样后跟(不是您可以打开的工作流)*。
  • 请求您的角色所隐藏项目的页面时,响应的方式如同该项目不存在。

架构师可以打开所有内容,因此架构师看到的页面会显示已删除的表、(未找到表)、已删除的步骤或*(未找到工作流)*。

  • 行数、大小和更新时间。
  • 步骤仅通过其 SQL 文本或表达式访问的表。 页面列出的是步骤在其设置中指定的表。
  • 未保存的编辑。 页面描述的是已保存的设置。
  • 当您在针对某个项目打开的对话中询问表、步骤或工作流时,Weave AI 可以读取其页面,并根据页面内容作答。请参阅 Weave AI 聊天。
  • 通过 MCP 连接的 AI 助手可以使用 doc_describe 工具读取同一页面,需提供项目、该项是表、步骤还是工作流,以及它的 ID。这需要对步骤、工作流和表的读取权限,并遵循相同的关于角色所隐藏内容的规则。请参阅 AI 代理 (MCP)。