# 声明式流水线

声明式管道允许您定义、配置和部署 Qlik Talend Data Integration 管道项目，完全通过 YAML 文件以代码形式实现。您可以在任何集成开发环境或版本控制系统中编辑文件，然后部署它们以创建或更新项目。

## 何时使用声明式流水线

使用声明式管道来提升：

* 协作

* 持续集成 / 持续交付

* 可重复的部署到不同环境

* API 驱动的自动化

某些典型用例如下：

* 在代码中定义管道，用于持续集成和开发自动化。

* 部署相同的管道配置跨多个环境（开发、验证、生产）。

* 跨项目或团队复用和共享管道定义。

* Automate 大规模项目创建，无需手动操作。

## 工作方式

一个管道项目表示为一组 YAML 文件，这些文件组织在一个文件夹结构中，该结构反映了项目的任务和数据集。YAML 文件更易于阅读、查看差异、审查、复用以及创建自动化。

您可以将现有项目导出为 YAML，编辑文件，然后将其导回以应用您的更改。如果项目已连接到版本控制，YAML 文件可直接在您的 GitHub 储存库中可用。

有关 YAML 文件结构的更多信息，请参阅 [检索和编辑管道配置](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DeclarativePipelines/Retrieving-editing-pipeline-configuration.htm)。

信息注释绑定文件（qtcp\_bindings\_definition.json 和 binding.json）保持 JSON 格式，以兼容绑定 API。对于旧版导出或在现有 GitHub 项目中，该文件名为bindingTemplate.json而不是qtcp\_bindings\_definition.json。

## 典型工作流程

在开始之前，您必须设置您的开发环境和版本控制。有关更多信息，请参阅[开始使用声明式流水线](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DeclarativePipelines/Getting-started-declarative-pipelines.htm)。

一个典型的声明式管道工作流如下所示：

1. 检索管道配置

   您可以将现有项目导出为 YAML，从版本控制中检索，或从模板开始。

   [检索和编辑管道配置](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DeclarativePipelines/Retrieving-editing-pipeline-configuration.htm)

2. 编辑管道配置

   修改您的开发环境中的 YAML 文件。您可以添加任务、更改源选择和更新设置。

   [开发者指南：声明性管道](http://qlik.dev/manage/di-projects/declarative-pipelines/)

3. 验证管道配置

   在部署管道之前，检查文件的语法和语义错误。

   [验证管道配置](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DeclarativePipelines/Validating-pipeline-configuration.htm)

4. 部署管道配置

   导入文件以在Qlik Talend Data Integration中创建或更新项目。

   您还可以将文件提交到版本控制，并在 Qlik Talend Data Integration 中的项目中执行从版本控制应用。

   [部署管道配置](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DeclarativePipelines/Deploying-pipeline-configuration.htm)

## 与版本控制的关系

当项目连接到版本控制时，YAML 文件会直接存储在您的 GitHub 储存库中。您可以在 GitHub 或任何 IDE 中编辑 YAML 文件，然后将更改应用回项目。

有关将项目连接到版本控制的信息，请参阅 [使用版本控制管理您的管道项目](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/VersionControl/Project-version-control.htm)。

信息注释如果您有一个已连接到版本控制并使用旧版 JSON 格式的现有项目，则可以将其迁移到 YAML。有关更多信息，请参阅[将项目迁移到 YAML 格式](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/DataIntegration/DeclarativePipelines/Retrieving-editing-pipeline-configuration.htm#Migrate)。

## 使用 AI 助手配置管道

使用 AI 助手（例如 GitHub Copilot 或 Anthropic Claude）简化 YAML 配置的创建和编辑。为确保准确度并符合项目标准，请关注以下最佳实践：

1. **选择高能力模型** — 使用高级、大上下文模型（例如，Anthropic Claude Sonnet 4.6 或更高版本），而不是标准或“自动”模型，用于复杂的 YAML 生成和模式一致性。高级模型正确地解释复杂的管道架构并生成更准确的配置。

2. **配置项目专属的 AI 指令** — 通过向模型提供项目上下文，提高 AI 生成的配置质量。在您的 VS Code 工作区的根目录中创建说明文件。选择以下项之一：

   * CLAUDE.md (用于 Anthropic Claude 代码扩展)

   * .github/copilot-instructions.md （适用于 GitHub Copilot）

   您的说明文件内容应如下所示：

   ```
   This is a Qlik Talend Cloud Pipeline (QTCP) project. Before any project advice or YAML edits, I MUST read the source of truth first:
   https://raw.githubusercontent.com/qlik-oss/schemas/refs/heads/main/qtcp/ai-instructions.md
   ```

## 使用 AI 助手与 Qlik MCP 工具

当您在您的租户中部署一个 Qlik MCP 服务器时，AI 助手可以使用专用的 MCP 工具，以编程方式帮助管理管道项目。

### 先决条件

* Qlik MCP 服务器部署在您的租户中

* 您拥有 Qlik MCP：允许 权限，该权限通过自定义角色分配

* 您有权限创建或编辑管道项目

* 一个支持 MCP 的 AI 客户端（例如带有 GitHub Copilot 的 VS Code）被配置为使用Qlik MCP 服务器

### 数据管道可用的 MCP 功能

AI 助手可以使用以下功能来配置和管理管道项目：

* **搜索空间** — 获取可用空间列表。

* **搜索连接** — 获取可用数据连接的列表。

* **搜索项目** — 获取现有管道项目列表。

* **搜索连接对象** — 发现数据源中可用的表和视图。

* **获取管道项目详情** — 检索项目绑定值。

### 相关资源

* 要部署 MCP 服务器，请参阅[Qlik MCP 服务器](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/QlikMCP/Qlik-MCP-server.htm)

* 有关详细的 MCP 工具文档，请参阅[Qlik MCP 工具](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/QlikMCP/Qlik-MCP-server-tools.htm)

* 有关权限要求，请参阅 [Qlik MCP 服务器访问和权限](https://help.qlik.com/zh-CN/cloud-services/Subsystems/Hub/Content/Sense_Hub/QlikMCP/Qlik-MCP-Permissions.htm)