mcpField
S
sf-soql

sf-soql

github.com/clientell-aiData & databases20104 installsUpdated 32w ago
Repository

About sf-soql

A SOQL query-building and optimization guide for Salesforce developers, covering relationship queries, aggregates, SOSL, and dynamic SOQL. It emphasizes user-mode security, bind variables, selective filters, and common limits.

Key features

  1. 01Build relationship and aggregate queries
  2. 02Use SOSL for full-text search
  3. 03Apply user mode and bind variables
  4. 04Identify inefficient query patterns
  5. 05Analyze performance with query plans
  6. 06Check query limits and syntax caveats

Use cases

  1. 01Write Salesforce queries with access controls
  2. 02Search text across multiple objects
  3. 03Optimize queries on large datasets
  4. 04Investigate query plans and limit issues

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/clientell-ai/salesforce-skills --skill sf-soql

After installing, type/sf-soqlin Claude Code to confirm it loaded.

Bundled filesreferences/soql-reference.md

Details

From the project README

SOQL Query Builder & Optimizer

You are a Salesforce SOQL specialist. Build optimized, secure queries.

Security First

  • ALWAYS use WITH USER_MODE to enforce CRUD/FLS
  • NEVER use string concatenation for dynamic SOQL — use bind variables
  • Use Database.query() only when dynamic queries are truly needed
// GOOD
List<Account> accounts = [
    SELECT Id, Name, Industry
    FROM Account
    WHERE Industry = :industryFilter
    WITH USER_MODE
    LIMIT 200
];

// BAD — injection risk
String query = 'SELECT Id FROM Account WHERE Name = \'' + userInput + '\'';

Query Patterns

Parent-to-Child (Subquery)
SELECT Id, Name,
    (SELECT Id, FirstName, LastName FROM Contacts)
FROM Account
WHERE Industry = 'Technology'
WITH USER_MODE
Child-to-Parent (Dot Notation)
SELECT Id, FirstName, Account.Name, Account.Industry
FROM Contact
WHERE Account.Industry = 'Technology'
WITH USER_MODE
Aggregate Queries
SELECT Industry, COUNT(Id) cnt, SUM(AnnualRevenue) totalRevenue
FROM Account
WHERE Industry != null
WITH USER_MODE
GROUP BY Industry
HAVING COUNT(Id) > 5
ORDER BY COUNT(Id) DESC
Polymorphic (TYPEOF)
SELECT Id, Subject,
    TYPEOF What
        WHEN Account THEN Name, Industry
        WHEN Opportunity THEN Name, StageName, Amount
    END
FROM Task
WITH USER_MODE
Semi-Joins and Anti-Joins
-- Semi-join: Accounts WITH contacts
SELECT Id, Name FROM Account
WHERE Id IN (SELECT AccountId FROM Contact)
WITH USER_MODE

-- Anti-join: Accounts WITHOUT opportunities
SELECT Id, Name FROM Account
WHERE Id NOT IN (SELECT AccountId FROM Opportunity)
WITH USER_MODE
SOSL (Search Language)

Use SOSL for full-text search across multiple objects:

FIND {SearchTerm} IN ALL FIELDS
RETURNING Account(Id, Name WHERE Industry = 'Tech'),
          Contact(Id, FirstName, LastName)
LIMIT 20
  • Use SOSL when: searching text across objects, fuzzy matching, partial words
  • Use SOQL when: exact matches, relationship queries, aggregates, DML-related queries
  • Governor limit: 20 SOSL queries per transaction
Date Literals
LiteralMeaning
TODAY, YESTERDAY, TOMORROWCalendar day
THIS_WEEK, LAST_WEEK, NEXT_WEEKSun-Sat week
THIS_MONTH, LAST_MONTH, NEXT_MONTHCalendar month
THIS_QUARTER, LAST_QUARTERCalendar quarter
THIS_YEAR, LAST_YEAR, NEXT_YEARCalendar year
LAST_N_DAYS:nPast n days (includes today)
NEXT_N_DAYS:nNext n days (includes today)
LAST_90_DAYSPast 90 days
THIS_FISCAL_QUARTER, THIS_FISCAL_YEARFiscal periods
N_DAYS_AGO:nExactly n days ago
FIELDS() Functions
SELECT FIELDS(ALL) FROM Account LIMIT 200    -- All fields (LIMIT required)
SELECT FIELDS(STANDARD) FROM Account          -- Standard fields only
SELECT FIELDS(CUSTOM) FROM Account            -- Custom fields only
Dynamic SOQL
String query = 'SELECT Id, Name FROM Account WHERE Industry = :industry';
List<Account> results = Database.query(query, AccessLevel.USER_MODE);
  • Always use AccessLevel.USER_MODE with Database.query()
  • Use :bindVariable syntax — never string concatenation
  • For truly dynamic field names: String.escapeSingleQuotes()
Utility Functions
  • toLabel(PicklistField) — returns translated picklist label
  • FORMAT(NumberField) — locale-formatted number/date
  • convertCurrency(Amount) — converts to user's currency (multi-currency orgs)
Record Locking
SELECT Id, Name FROM Account WHERE Id = :accountId FOR UPDATE

Pessimistic lock — blocks other transactions from updating until commit/rollback.

ALL ROWS (Including Deleted)
SELECT Id, Name FROM Account WHERE IsDeleted = true ALL ROWS

Returns soft-deleted records (retained 15 days in Recycle Bin).

SOQL For Loops
for (List<Account> batch : [SELECT Id, Name FROM Account]) {
    // Processes 200 records per iteration automatically
    // Uses minimal heap — ideal for large datasets
}
Geolocation Queries
SELECT Id, Name, DISTANCE(Location__c, GEOLOCATION(37.7749, -122.4194), 'mi') dist
FROM Store__c
WHERE DISTANCE(Location__c, GEOLOCATION(37.7749, -122.4194), 'mi') < 50
ORDER BY DISTANCE(Location__c, GEOLOCATION(37.7749, -122.4194), 'mi')
WITH SECURITY_ENFORCED vs WITH USER_MODE
FeatureSECURITY_ENFORCEDUSER_MODE
FLS enforcementSELECT/FROM onlySELECT/FROM/WHERE/subqueries
On violationThrows exceptionSilently strips inaccessible fields
Restriction rulesNot supportedSupported
RecommendationLegacy — migrate awayPreferred

Optimization Rules

Selective Filters (use indexed fields)
  • Id, Name, OwnerId, CreatedDate, SystemModstamp
  • RecordTypeId, Lookup fields, External ID fields
  • Custom fields marked as External ID or with custom index
Anti-Patterns to Detect
  1. Query in loop — move query before the loop, use Map/Set
  2. Non-selective filter — filter on indexed fields first
  3. SELECT * equivalent — never select all fields, only what's needed
  4. Missing LIMIT — add LIMIT for queries that could return large datasets
  5. Negative filters — != and NOT IN are non-selective
  6. Leading wildcard — LIKE '%term' cannot use indexes
  7. Missing WHERE clause — always filter unless deliberately loading all
Query Plan Analysis
sf data query -q "EXPLAIN SELECT Id FROM Account WHERE Name = 'Test'" --target-org myOrg

Limits

  • 100 SOQL queries per synchronous transaction
  • 200 SOQL queries per asynchronous transaction
  • 50,000 rows returned per transaction
  • 2,000 rows in a subquery
  • 20 relationship queries per parent query

Gotchas

  • FIELDS(ALL) REQUIRES LIMIT 200 — fails without it
  • COUNT() counts all rows including nulls; COUNT(fieldName) counts non-null only
  • FOR UPDATE locks the ENTIRE row — other transactions wait or timeout
  • SOSL has its own governor limit: 20 queries/transaction (separate from SOQL's 100)
  • Date literals include the boundary day — LAST_N_DAYS:7 includes today
  • TYPEOF only works on polymorphic fields (Task.What, Event.Who, etc.)
  • Subquery result limit is 2,000 rows — not 50,000
  • FIELDS(ALL) is not supported in Apex — only REST API and Developer Console
  • Database.query() does not support FIELDS() — use explicit field lists
  • ALL ROWS cannot be used with FOR UPDATE

Workflow

  1. Understand the data requirements
  2. Check object relationships and field types
  3. Build query with proper filters, security, and limits
  4. Test with: sf data query -q "YOUR_QUERY" --target-org myOrg
  5. Optimize based on results and explain plan

References

  • SOQL/SOSL Reference — date literals, SOSL syntax, FIELDS(), geolocation, dynamic SOQL, aggregates, FOR UPDATE, bind patterns, query plans
  • Governor Limits — SOQL query limits per transaction

Comments

Markdown supported