mcpField
R
retrieving-datacloud

retrieving-datacloud

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

关于 retrieving-datacloud

面向 Salesforce Data Cloud 检索任务的技能,涵盖 SQL 查询、架构检查、向量与混合搜索及搜索索引操作,并指导查询选择和就绪状态检查。

主要功能

  1. 01同步与分页 SQL 查询
  2. 02异步查询工作流
  3. 03表结构检查
  4. 04向量与混合搜索
  5. 05搜索索引操作

适用场景

  1. 01检查 Data Cloud 表和字段
  2. 02处理大型查询结果集
  3. 03语义搜索已索引内容

安装

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

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

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

包含的文件

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

CREDITS.md
README.md
examples/search-indexes/
hybrid-structured.json
vector-knowledge.json

详细介绍

retrieving-datacloud:Data Cloud 检索阶段

当用户需要对 Data Cloud 进行查询、搜索和元数据探查时使用此技能:同步 SQL、分页 SQL、异步查询工作流、表描述、向量搜索、混合搜索或搜索索引操作。

此技能负责的任务

当工作涉及以下内容时,使用 retrieving-datacloud:

  • sf data360 query *
  • sf data360 search-index *
  • sf data360 metadata *
  • 检查 sf data360 profile * 或 sf data360 insight *
  • 理解 Data Cloud SQL 结果或查询结构

以下情况应委派给其他技能:


首先收集所需上下文

询问或推断:

  • 目标组织别名
  • 用户需要快速计数、中等规模结果集、大型导出、架构检查还是语义搜索
  • 已知的表名/索引名
  • 任务是只读 SQL,还是搜索索引生命周期管理

核心操作规则

  • 将 Data Cloud SQL 视为独立的查询语言,而非 SOQL。
  • 在依赖查询/搜索功能之前,先运行共享就绪状态分类器:node ../orchestrating-datacloud/scripts/diagnose-org.mjs -o <org> --phase retrieve --json。
  • 使用 describe 后再推测列名。
  • 对于较大的结果集,优先使用 sqlv2 或异步查询流程。
  • 仅当搜索索引生命周期正常时,才使用向量搜索或混合搜索。
  • 不要在此技能系列中处理 STDM/Parquet/会话跟踪工作流。

推荐工作流

1. 对检索工作的就绪状态进行分类
node ../orchestrating-datacloud/scripts/diagnose-org.mjs -o <org> --phase retrieve --json
# optional query-plane probe, only with a real table name
node ../orchestrating-datacloud/scripts/diagnose-org.mjs -o <org> --phase retrieve --describe-table MyDMO__dlm --json
2. 选择满足需求的最小查询结构
sf data360 query sql -o <org> --sql 'SELECT COUNT(*) FROM "ssot__Individual__dlm"' 2>/dev/null
sf data360 query sqlv2 -o <org> --sql 'SELECT * FROM "ssot__Individual__dlm"' 2>/dev/null
sf data360 query async-create -o <org> --sql 'SELECT * FROM "ssot__Individual__dlm"' 2>/dev/null
3. 使用 describe 后再推测字段
sf data360 query describe -o <org> --table ssot__Individual__dlm 2>/dev/null
4. 仅在索引存在时使用向量或混合搜索
sf data360 search-index list -o <org> 2>/dev/null
sf data360 query vector -o <org> --index Knowledge_Index --query "reset password" --limit 5 2>/dev/null
sf data360 query hybrid -o <org> --index Knowledge_Index --query "reset password" --limit 5 2>/dev/null
sf data360 query hybrid -o <org> --index Insurance_Index --query "weather damage coverage" --prefilter "Type_of_Insurance__c='Home'" --limit 10 2>/dev/null
5. 创建索引时复用经过整理的搜索索引示例

使用阶段专属示例,不要从头编造 JSON:

  • examples/search-indexes/vector-knowledge.json
  • examples/search-indexes/hybrid-structured.json

重要注意事项

  • Data Cloud SQL 不是 SOQL。
  • SQL 中的表名应使用双引号括起。
  • 对于中等规模结果集,sqlv2 优于临时使用 OFFSET 分页。
  • 对于大型结果,优先使用异步查询。
  • 搜索索引操作以及向量/混合查询,都依赖搜索索引生命周期处于正常状态。
  • 混合搜索可以使用 --prefilter,但仅限于创建搜索索引时配置为支持预筛选的字段。
  • 创建时,HNSW 索引参数通常为只读;除非平台明确说明,否则请将 userValues: [] 保持原样。
  • query describe 并非通用的租户探测工具;只有在更广泛的就绪状态确认完成后,才使用已知的 DMO 或 DLO 表运行该命令。

输出格式

Retrieve task: <sql / sqlv2 / async / describe / vector / search-index>
Target org: <alias>
Target object: <table or index>
Commands: <key commands run>
Verification: <query rows / schema / status>
Next step: <segment / harmonize / follow-up>

参考资料

评论

支持 Markdown