KysoqlSalesforce reference map
Map Kysoql builders to the official Salesforce SOQL and REST API documentation.
Kysoql deliberately uses Salesforce terminology rather than inventing a second query language. Use this page when you know the SOQL feature you need and want the corresponding typed builder API.
SOQL SELECT
Salesforce documents a SELECT statement as a field list plus optional clauses
such as WHERE, GROUP BY, and ORDER BY. Kysoql exposes those concepts as
builder methods and validates them against generated Describe metadata.
| Salesforce concept | Kysoql guide | Official Salesforce documentation |
|---|---|---|
SOQL overview and SELECT syntax | Mental model | Salesforce Object Query Language (SOQL) |
Field lists and FIELDS() | Selecting fields | SELECT |
WHERE conditions | Filtering records | WHERE |
ORDER BY, LIMIT, and OFFSET | Ordering and pagination | ORDER BY and OFFSET |
| Parent and child relationships | Relationships and joins | Relationship queries |
Aggregate functions and GROUP BY | Counts and aggregate reports | Aggregate functions and GROUP BY |
| Date functions and literals | Date functions and literals | Date functions and date formats/literals |
| SOQL select functions | Labels, currency, and formatting | SOQL SELECT functions |
REST query execution
Kysoql's native REST executor targets Salesforce's Query and QueryAll resources.
The executor follows Salesforce query locators internally for both root results and
selected parent-to-child subqueries, including nested subqueries, rather than
pretending OFFSET is a cursor or making applications handle nextRecordsUrl.
| Salesforce API concept | Kysoql guide | Official Salesforce documentation |
|---|---|---|
| Execute a SOQL query | Native REST execution | Query resource |
| Retrieve additional pages | Native REST execution | Execute a SOQL query |
| Include deleted records | Native REST execution | Working with searches and queries |
Compare equivalent queries
Salesforce's reference commonly starts from raw SOQL. The equivalent Kysoql builder keeps the same concepts visible:
SELECT Id, Name, BillingCity
FROM Account
WHERE Name LIKE 'A%'
ORDER BY Name DESC NULLS LAST
LIMIT 25import { db } from "./db";
const query = db
.selectFrom("Account")
.select(["Id", "Name", "BillingCity"])
.where("Name", "like", "A%")
.orderBy("Name", "desc", "last")
.limit(25);
query.compile().soql;The builder does not replace Salesforce documentation for server-side limits, permissions, API-version behaviour, or feature availability. Treat Salesforce's reference as authoritative for the platform and these docs as authoritative for Kysoql's typed API.