mcpField
C
connecting-datacloud

connecting-datacloud

github.com/forcedotcom数据与数据库1.1k2.5k 次安装1 天前更新
代码仓库

关于 connecting-datacloud

面向 Salesforce Data Cloud 连接阶段工作的技能，借助 sf CLI 发现、检查、测试和配置数据源连接。涵盖多种外部连接器，并提供配置示例。

主要功能

  1. 01发现连接器类型
  2. 02检查连接和来源架构
  3. 03测试及管理连接
  4. 04提供连接配置示例

适用场景

  1. 01查看组织中已配置的连接器
  2. 02检查外部来源的对象与字段
  3. 03创建 Ingestion API 连接并上传架构

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/forcedotcom/sf-skills --skill connecting-datacloud

安装后在 Claude Code 中输入/connecting-datacloud确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

CREDITS.md
README.md
examples/connections/
heroku-postgres.json
ingest-api-connection.json
ingest-api-schema.json
redshift.json
sharepoint-unstructured.json
snowflake-connection.json

详细介绍

connecting-datacloud：Data Cloud 连接阶段

当用户需要源连接相关工作时使用此技能：发现连接器、查看连接元数据、测试连接、浏览源对象、检查连接器架构，或为外部数据源准备特定连接器的配置载荷。

此技能负责的任务

以下工作使用 connecting-datacloud：

  • sf data360 connection *
  • 检查连接器目录
  • 创建、更新、测试或删除连接
  • 浏览源对象、字段、数据库或架构
  • 识别当前正在使用的连接器类型
  • 为 Snowflake、SharePoint Unstructured 或 Ingestion API 数据源准备连接器定义

以下任务应交由其他技能处理：

首先收集必要的上下文

询问或推断以下信息：

  • 目标 org 别名
  • 连接器类型或源系统
  • 用户只想检查，还是要实际修改
  • 已有连接的名称或 ID（如有）
  • 凭据是否已在 CLI 之外配置
  • 用户是否还希望在连接设置完成后立即创建数据流
  • 数据源属于数据库、非结构化文档源，还是 Ingestion API 数据流

核心操作规则

  • 首先验证插件运行时；请参阅 ../orchestrating-datacloud/references/plugin-setup.md。
  • 修改连接前运行共享的就绪状态分类器：node ../orchestrating-datacloud/scripts/diagnose-org.mjs -o <org> --phase connect --json。
  • 创建连接前优先进行只读发现。
  • 按标准用法使用 2>/dev/null，抑制关联插件的警告噪声。
  • 请记住，connection list 需要 --connector-type。
  • 使用名称解析非 Salesforce 连接时，运行 connection test 请传入 --connector-type。
  • 如果对该 org 不熟悉，先从数据流中发现现有的连接器类型。
  • 编写特定连接器的凭据或参数前，先参考经过整理的示例载荷。
  • 对于示例中未涵盖的连接器类型，先通过 REST 检查一个已知可用、由 UI 创建的连接，再构建 JSON。
  • 不要仅因连接创建成功，就承诺所有连接器类型都支持通过 API 创建数据流。

推荐工作流

1. 对连接任务进行就绪状态分类
node ../orchestrating-datacloud/scripts/diagnose-org.mjs -o <org> --phase connect --json
2. 发现连接器类型
sf data360 connection connector-list -o <org> 2>/dev/null
sf data360 data-stream list -o <org> 2>/dev/null
3. 按类型检查连接
sf data360 connection list -o <org> --connector-type SalesforceDotCom 2>/dev/null
sf data360 connection list -o <org> --connector-type REDSHIFT 2>/dev/null
sf data360 connection list -o <org> --connector-type SNOWFLAKE 2>/dev/null
4. 检查特定连接或已上传的架构
sf data360 connection get -o <org> --name <connection> 2>/dev/null
sf data360 connection objects -o <org> --name <connection> 2>/dev/null
sf data360 connection fields -o <org> --name <connection> 2>/dev/null
sf data360 connection schema-get -o <org> --name <connection-id> 2>/dev/null
5. 发现完成后再测试或创建
sf data360 connection test -o <org> --name <connection> --connector-type <type> 2>/dev/null
sf data360 connection create -o <org> -f connection.json 2>/dev/null
6. 使用外部连接器的整理示例载荷起步

从此阶段提供的示例开始，不要从头编写载荷：

  • examples/connections/heroku-postgres.json
  • examples/connections/redshift.json
  • examples/connections/sharepoint-unstructured.json
  • examples/connections/snowflake-connection.json
  • examples/connections/ingest-api-connection.json
  • examples/connections/ingest-api-schema.json

典型的 Ingestion API 设置流程：

sf data360 connection create -o <org> -f examples/connections/ingest-api-connection.json 2>/dev/null
sf data360 connection schema-upsert -o <org> --name <connector-id> -f examples/connections/ingest-api-schema.json 2>/dev/null
sf data360 connection schema-get -o <org> --name <connector-id> 2>/dev/null
7. 发现未知连接器类型的载荷字段

先在 UI 中创建一个连接，然后直接检查：

sf api request rest "/services/data/v66.0/ssot/connections/<id>" -o <org>

高信号注意事项

  • connection list 没有真正的全局“列出全部”模式；请按连接器类型查询。
  • 连接器目录中的名称与连接的连接器类型名称不总是相同。
  • 如果来源不是默认的 Salesforce 连接器，connection test 可能需要 --connector-type 来解析名称。
  • 连接列表为空通常表示“已启用，但尚未配置”，而不是“功能已禁用”。
  • Heroku Postgres、Redshift、Snowflake、SharePoint Unstructured 和 Ingestion API 使用的凭证和参数结构各不相同；请使用整理好的示例，不要凭猜测操作。
  • SharePoint Unstructured 在 credentials 数组中使用 clientId、clientSecret 和 tokenEndpoint，不需要 parameters 数组。
  • Snowflake 使用密钥对身份验证，通常可以通过 API 创建，但下游流的创建仍可能只能在 UI 中完成。
  • Ingestion API 连接器设置只有在 connection schema-upsert 上传对象架构后才算完成。
  • 部分外部连接器的凭证设置仍依赖 UI 端配置或外部系统权限。

输出格式

Connect task: <inspect / create / test / update>
Connector type: <SalesforceDotCom / REDSHIFT / SNOWFLAKE / SPUnstructuredDocument / IngestApi / ...>
Target org: <alias>
Commands: <key commands run>
Verification: <passed / partial / blocked>
Next step: <prepare phase or connector follow-up>

参考资料

评论

支持 Markdown