Skip to main content
skill CX Codex

platform-soql-query — Claude Code skill for SOQL and SOSL

Writes and tunes Salesforce SOQL/SOSL: turns a plain-language request into a query, checks selectivity and reads the query plan.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add forcedotcom/sf-skills --skill platform-soql-query -a claude-code
Open on GitHub

What platform-soql-query does

The skill kicks in when you edit .soql files, describe the query you want in words, or dig into a slow one. It picks the shape for you: child-to-parent traversal, a subquery, an aggregate with COUNT and GROUP BY, semi-join and anti-join, or SOSL when the search spans objects.

Bundled references cover syntax, operators and date literals, selectivity and indexing rules, common anti-patterns, and Apex selector templates. Starter query files sit in assets/, and scripts/post-tool-validate.py runs after a .soql edit to do static validation plus live query plan analysis.

It expects jq 1.6.0 or newer, python3 3.10.0 or newer, and Salesforce CLI sf 2.0.0 or newer. Running a query against an org is not its job — that goes to platform-data-manage, and DML inside Apex belongs to platform-apex-generate. When a query moves into Apex, security mode and field access are on you to verify; the skill flags them but does not enforce anything.

What it helps with

  • turn a plain-language request into a working SOQL query
  • find the non-selective filter behind a slow query
  • swap record loading for an aggregate with COUNT and GROUP BY
  • choose between a subquery and a relationship traversal
  • check a freshly edited .soql file for anti-patterns

Example prompts for the agent

  • write SOQL for all contacts with an email, newest first
  • why is this query slow? check the selectivity of the filters
  • rewrite this as an aggregate with COUNT grouped by status

How to install platform-soql-query

1Skills CLI (Vercel)

npx skills add forcedotcom/sf-skills --skill platform-soql-query -a claude-code

2Manually: put the files in place

~/.claude/skills/platform-soql-query/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/platform-soql-query/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about platform-soql-query

How do I install platform-soql-query in Claude?

Run npx skills add forcedotcom/sf-skills --skill platform-soql-query -a claude-code. The skill lands at ~/.claude/skills/platform-soql-query/SKILL.md.

What does platform-soql-query do?

It helps author and optimize SOQL and SOSL: generating queries from a description, choosing relationship or aggregate shapes, and reviewing selectivity and query plans.

How is it different from platform-data-manage?

This skill handles query shape and optimization. Executing against an org, exporting, and bulk operations belong to platform-data-manage.

Source text

SKILL.md · Apache-2.0
---
name: platform-soql-query
description: "Use when the user needs SOQL/SOSL authoring or optimization: natural-language-to-query generation, relationship queries, aggregates, query-plan/selectivity analysis, and performance or safety improvements. TRIGGER when the user writes, optimizes, or debugs SOQL/SOSL, touches .soql files, or asks about relationship queries, aggregates, or query performance. DO NOT TRIGGER for bulk data operations (use platform-data-manage), Apex DML logic (use platform-apex-generate), or report/dashboard queries."
metadata:
  version: "1.1"
  domains: ["Platform"]
  relatedSkills:
    - "experience-lwc-generate"
    - "platform-apex-generate"
    - "platform-apex-logs-debug"
    - "platform-apex-test-run"
    - "platform-data-manage"
  cliTools:
    - tool: ["jq"]
      semver: ">=1.6.0"
    - tool: ["python3"]
      semver: ">=3.10.0"
    - tool: ["sf"]
      semver: ">=2.0.0"
---

# platform-soql-query: Salesforce SOQL Query Expert

Use this skill when the user needs **SOQL/SOSL authoring or optimization**: natural-language-to-query generation, relationship queries, aggregates, query-plan analysis, and performance/safety improvements for Salesforce queries.

## When This Skill Owns the Task

Use `platform-soql-query` when the work involves:
- `.soql` files
- query generation from natural language
- relationship queries and aggregate queries
- query optimization and selectivity analysis
- SOQL/SOSL syntax and governor-aware design

Delegate elsewhere when the user is:
- performing bulk data operations → [platform-data-manage](../platform-data-manage/SKILL.md)
- embedding query logic inside broader Apex implementation → [platform-apex-generate](../platform-apex-generate/SKILL.md)
- debugging via logs rather than query shape → [platform-apex-logs-debug](../platform-apex-logs-debug/SKILL.md)

---

## Required Context to Gather First

Ask for or infer:
- target object(s)
- fields needed
- filter criteria
- sort / limit requirements
- whether the query is for display, automation, reporting-like analysis, or Apex usage
- whether performance / selectivity is already a concern

---

## Recommended Workflow

### 1. Generate the simplest correct query
Prefer:
- only needed fields
- clear WHERE criteria
- reasonable LIMIT when appropriate
- relationship depth only as deep as necessary

### 2. Choose the right query shape
| Need | Default pattern |
|---|---|
| parent data from child | child-to-parent traversal |
| child rows from parent | subquery |
| counts / rollups | aggregate query |
| records with / without related rows | semi-join / anti-join |
| text search across objects | SOSL |

### 3. Optimize for selectivity and safety
Check:
- indexed / selective filters
- no unnecessary fields
- no avoidable wildcard or scan-heavy patterns
- security enforcement expectations

### 4. Validate execution path if needed
If the user wants runtime verification, hand off execution to:
- [platform-data-manage](../platform-data-manage/SKILL.md)

---

## High-Signal Rules

- never use `SELECT *` style thinking; query only required fields
- do not query inside loops in Apex contexts
- prefer filtering in SOQL rather than post-filtering in Apex
- use aggregates for counts and grouped summaries instead of loading unnecessary records
- evaluate wildcard usage carefully; leading wildcards often defeat indexes
- account for security mode / field access requirements when queries move into Apex

---

## Output Format

When finishing, report in this order:
1. **Query purpose**
2. **Final SOQL/SOSL**
3. **Why this shape was chosen**
4. **Optimization or security notes**
5. **Execution suggestion if needed**

Suggested shape — use `references/soql-syntax-reference.md` for exact syntax:

```text
Query goal: <summary>
Query: <soql or sosl>
Design: <relationship / aggregate / filter choices>
Notes: <selectivity, limits, security, governor awareness>
Next step: <run in platform-data-manage or embed in Apex>
```

---

## Cross-Skill Integration

| Need | Delegate to | Reason |
|---|---|---|
| run the query against an org | [platform-data-manage](../platform-data-manage/SKILL.md) | execution and export |
| embed the query in services/selectors | [platform-apex-generate](../platform-apex-generate/SKILL.md) | implementation context |
| analyze slow-query symptoms from logs | [platform-apex-logs-debug](../platform-apex-logs-debug/SKILL.md) | runtime evidence |
| wire query-backed UI | [experience-lwc-generate](../experience-lwc-generate/SKILL.md) | frontend integration |
| validate query behavior in tests | [platform-apex-test-run](../platform-apex-test-run/SKILL.md) | test coverage for query logic |

---

## Score Guide

| Score | Meaning |
|---|---|
| 90+ | production-optimized query |
| 80–89 | good query with minor improvements possible |
| 70–79 | functional but performance concerns remain |
| < 70 | needs revision before production use |

---

## Reference File Index

| File | When to read |
|------|-------------|
| `references/soql-syntax-reference.md` | Syntax, operators, date literals, relationship query patterns |
| `references/query-optimization.md` | Selectivity rules, indexing strategy, governor limits, security patterns |
| `references/soql-reference.md` | Quick reference — operators, date functions, aggregate functions, WITH clauses |
| `references/anti-patterns.md` | Common SOQL mistakes and their fixes — read before finalizing any query |
| `references/selector-patterns.md` | Apex selector layer patterns — read when embedding queries in Apex classes |
| `references/field-coverage-rules.md` | Field coverage validation — read when generating SOQL used inside Apex code |
| `references/cli-commands.md` | sf CLI query execution, bulk export, query plan commands |
| `assets/basic-queries.soql` | Starter query examples for common objects |
| `assets/relationship-queries.soql` | Parent-to-child and child-to-parent relationship query patterns |
| `assets/aggregate-queries.soql` | COUNT, SUM, GROUP BY, ROLLUP query patterns |
| `assets/optimization-patterns.soql` | Selective filter and index-aware query patterns |
| `assets/bulkified-query-pattern.cls` | Apex Map-based bulk query pattern for trigger contexts |
| `assets/selector-class.cls` | Full selector class implementation template |
| `scripts/post-tool-validate.py` | Post-write hook — runs static SOQL validation and live query plan analysis after `.soql` file edits |

© forcedotcom · Apache-2.0 · forcedotcom/sf-skills

Similar skills

All skills for Data and databases →

From the same set167

platform-apex-generate Generates Apex classes and triggers, then runs the code analyzer and org tests. Useful when a Salesforce codebase keeps growing. CX Codex +1 7,100installs platform-apex-test-generate This skill writes and fixes Apex test classes: data factories, bulk runs, mocks and coverage analysis. Useful when a deploy stalls on missing coverage. CX Codex +1 7,000installs platform-apex-test-run Runs Apex tests via the Salesforce CLI, analyzes code coverage, and guides test-fix loops. Useful when investigating unit test failures or low coverage. CX Codex +1 6,900installs platform-apex-logs-debug This skill reads Salesforce debug logs: finds the root cause of a failure, spots governor limit hits and explains stack traces. CX Codex +1 6,800installs platform-metadata-deploy Automates Salesforce metadata deployments using sf CLI v2, enforces dry-run validations, and routes production rollouts through safe quick-deploy jobs. CX Codex +1 6,700installs platform-metadata-retrieve Pulls metadata from a Salesforce org into your local project with sf project retrieve start: all changes, a source directory, a type, a manifest or a package. CX Codex +1 6,600installs platform-permission-set-generate Creates Salesforce PermissionSet XML for object, field, user, and app permissions. Use it when editing FLS, tab visibility, or permission sets for deployment. CX Codex +1 6,500installs platform-docs-get Pulls official Salesforce documentation and keeps the agent answering from it instead of third-party blogs. Useful when pages are JS-heavy and a plain fetch returns an empty shell. CX Codex +1 6,500installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor