Core API reference

Generated API reference for query builders, schema types, compilation, plugins, and SOQL helpers in @kysoql/core.

Functions

Function	Description
apexAdd	Builds a typed Apex addition expression from compatible literal or bind operands.
apexBind	Creates a typed Apex bind expression from an identifier or dotted member path.
apexQueryField	References a selected field from an Apex query result for use in another bind expression.
apexSubstring	Builds a typed Apex substring expression using validated zero-based indexes.
applyQueryResultAliases	Applies Kysoql-only field aliases to records returned by Salesforce.
soqlCurrency	Creates a validated SOQL currency literal from a three-letter ISO code and finite value.
soqlLikeLiteral	Treat every character in a LIKE value literally, including `%` and `_`.
soqlMultiSelectAnd	Creates a multi-select picklist operand that requires every listed value to match.
soqlRelativeDate	Creates a validated fixed or parameterized Salesforce relative-date literal.
soqlDate	Creates a validated Salesforce SOQL date literal.
soqlDateTime	Creates a validated Salesforce SOQL datetime literal.
soqlTime	Creates a validated Salesforce SOQL time literal.

Classes

Class	Description
Kysoql	Configured query creator for building, compiling, and optionally executing typed SOQL.
NoResultError	Error thrown by `executeTakeFirstOrThrow()` when a query returns no rows.
DefaultQueryCompiler	Default compiler that validates a query AST and renders Salesforce SOQL.
QueryCreator	Entry point for creating typed queries from a Salesforce schema.

Interfaces

Interface	Description
ApexBindExpression	Typed Apex expression that can be embedded as a bind in generated dynamic SOQL.
ApexDatabaseQueryOptions	Compile-time marker for Salesforce `Database.QueryOptions`.
AggregateFormatFunctionBuilder	Builder for FORMAT() applied to an aggregate expression.
AggregateFunctionBuilder	Builder for a typed Salesforce aggregate function expression.
AggregateFunctionExpression	Typed aggregate-function expression that can be selected or compared.
AggregateFunctionModule	Aggregate and date-function helpers exposed to expression callbacks.
AliasedAggregateFunctionBuilder	Aliased aggregate expression produced for SELECT output.
AliasedDateFunctionBuilder	Aliased date-function expression produced for SELECT output.
AliasedSelectFunctionBuilder	Aliased scalar SELECT-function expression.
ConvertCurrencyFunctionBuilder	Builder for Salesforce convertCurrency() expressions.
ConvertTimezoneFunctionBuilder	Builder for an unaliased Salesforce convertTimezone() expression.
CountAllFunctionBuilder	Builder for Salesforce COUNT() without a field argument.
DateFunctionBuilder	Builder for Salesforce date functions such as CALENDAR_YEAR() and DAY_ONLY().
DateFunctionExpression	Typed Salesforce date-function expression that can be selected or grouped.
FormatFunctionBuilder	Builder for Salesforce FORMAT() expressions.
GroupingFunctionBuilder	Builder for Salesforce GROUPING() in aggregate queries.
SelectExpressionBuilder	Expression helper passed to typed SELECT and grouping callbacks.
SelectFunctionModule	Scalar, aggregate, date, and geolocation helpers exposed to SELECT callbacks.
ToLabelFunctionBuilder	Builder for Salesforce toLabel() expressions.
ExpressionBuilder	Expression helper passed to typed WHERE callbacks.
ExpressionWrapper	Typed wrapper around a filter operation node.
ToLabelFilterFunctionExpression	Typed toLabel() expression used in WHERE comparisons.
BetaExpressionModule	Beta expression helpers for Salesforce formula-field filter functions.
FormulaFilterFunctionExpression	Typed formula-function expression used in WHERE comparisons.
AliasedDistanceFunctionBuilder	Aliased DISTANCE() expression produced for SELECT output.
DistanceFunctionBuilder	Builder for Salesforce DISTANCE() expressions.
DistanceFunctionExpression	Typed Salesforce DISTANCE() expression.
GeolocationExpressionBuilder	Expression helper for geolocation-aware SELECT and ORDER BY callbacks.
GeolocationFilterExpressionBuilder	Expression helper for geolocation-aware WHERE callbacks.
GeolocationFilterFunctionModule	Geolocation expression helpers exposed to WHERE callbacks.
GeolocationFunctionBuilder	Builder for Salesforce GEOLOCATION() expressions.
GeolocationFunctionModule	Geolocation expression helpers exposed to SELECT and ORDER BY callbacks.
HavingExpressionBuilder	Expression helper passed to typed HAVING callbacks.
HavingExpressionWrapper	Typed wrapper around an aggregate HAVING expression node.
AggregateFunctionNode	Immutable query AST node for a Salesforce aggregate function.
AliasNode	Immutable query AST node for a SELECT alias.
AllRowsNode	Immutable query AST node for the ALL ROWS modifier.
AndNode	Immutable query AST node for logical AND.
ApexAccessModeNode	Immutable query AST node for an Apex query access mode.
ApexBindNode	Immutable query AST node for an Apex bind reference.
ApexAdditionNode	Immutable query AST node for an Apex addition expression.
ApexQueryResultNode	Immutable query AST node for a field read from an Apex query result.
ApexSubstringNode	Immutable query AST node for an Apex substring expression.
ApexLiteralNode	Immutable query AST node for an Apex literal value.
BinaryOperationNode	Immutable query AST node for a binary filter comparison.
ConvertCurrencyFunctionNode	Immutable query AST node for a convertCurrency() expression.
ConvertTimezoneFunctionNode	Immutable query AST node for a convertTimezone() expression.
DateFunctionNode	Immutable query AST node for a Salesforce date or fiscal date function.
DistanceFunctionNode	Immutable query AST node for a DISTANCE() expression.
FieldsFunctionNode	Immutable query AST node for a FIELDS() selection.
ForUpdateNode	Immutable query AST node for the FOR UPDATE clause.
ForViewReferenceNode	Immutable query AST node for a FOR VIEW or FOR REFERENCE clause.
FormatFunctionNode	Immutable query AST node for a FORMAT() expression.
FormulaFunctionNode	Immutable query AST node for a Salesforce formula filter function.
GeolocationFunctionNode	Immutable query AST node for a GEOLOCATION() expression.
GroupByNode	Immutable query AST node for a GROUP BY clause.
HavingNode	Immutable query AST node for a HAVING clause.
KnowledgeUpdateNode	Immutable query AST node for a Salesforce Knowledge UPDATE clause.
LimitNode	Immutable query AST node for a LIMIT clause.
NotNode	Immutable query AST node for logical NOT.
OffsetNode	Immutable query AST node for an OFFSET clause.
OperationNode	Union of immutable query AST node shapes understood by the Kysoql compiler.
OperatorNode	Immutable query AST node for a comparison operator.
OrNode	Immutable query AST node for logical OR.
OrderByItemNode	Immutable query AST node for one ORDER BY item.
OrderByNode	Immutable query AST node for an ORDER BY clause.
RawNode	Immutable query AST node for a trusted raw SOQL fragment.
RecordVisibilityContextNode	Immutable query AST node for a record-visibility context clause.
ReferenceNode	Immutable query AST node for a field or relationship reference.
RelationshipSubqueryNode	Immutable query AST node for a child relationship subquery.
SelectQueryNode	Immutable query AST node for a complete SELECT query.
SelectionNode	Immutable query AST node for one SELECT projection.
SemiJoinSubqueryNode	Immutable query AST node for a semi-join or anti-join subquery.
SetOptionsNode	Immutable query AST node for a SET OPTIONS clause.
SObjectNode	Immutable query AST node for a Salesforce object reference.
ToLabelFunctionNode	Immutable query AST node for a toLabel() expression.
TypeOfNode	Immutable query AST node for a TYPEOF selection.
TypeOfWhenNode	Immutable query AST node for one TYPEOF WHEN branch.
UserProfileFeedWithNode	Immutable query AST node for a UserProfileFeed WITH clause.
UsingScopeNode	Immutable query AST node for a USING SCOPE clause.
ValueListNode	Immutable query AST node for a list of bound SOQL values.
ValueNode	Immutable query AST node for a bound SOQL value.
WhereNode	Immutable query AST node for a WHERE clause.
DataCategorySelectionNode	Immutable query AST node for one WITH DATA CATEGORY selection.
WithDataCategoryNode	Immutable query AST node for a WITH DATA CATEGORY clause.
Data360DloSetOptions	SET OPTIONS supported by Salesforce Data 360 data lake objects.
Data360DmoSetOptions	SET OPTIONS supported by Salesforce Data 360 data model objects.
KysoqlPlugin	Hook contract for transforming Kysoql query trees and execution results.
PluginTransformQueryArgs	Arguments passed to a plugin before a query is compiled.
PluginTransformResultArgs	Arguments passed to a plugin after a query has executed.
AggregateSelectQueryBuilder	Type-safe builder for grouped and aggregate Salesforce SELECT queries.
ApexAggregateSelectQueryBuilder	Apex rendering wrapper for an aggregate SELECT query.
ApexCountQueryBuilder	Apex rendering wrapper for a COUNT() query.
ApexSelectQueryBuilder	Apex rendering wrapper for a typed SELECT query.
CountQueryBuilder	Type-safe builder for Salesforce COUNT() queries.
ExecuteTakeFirstOrThrowOptions	Options for customising the error thrown when a query returns no rows.
RelationshipSubqueryBuilder	Type-safe builder for a Salesforce child relationship subquery.
RelationshipSubqueryPilotModule	Pilot-only features available while building a relationship subquery.
SelectQueryBuilder	Type-safe fluent builder for Salesforce SELECT queries.
SelectQueryBuilderProps	Internal construction state exposed for advanced query-builder integrations.
SelectedSemiJoinSubqueryBuilder	Completed semi-join subquery with its selected reference field.
SemiJoinQueryCreator	Query-creator contract exposed inside semi-join callbacks.
SemiJoinSubqueryBuilder	Builder for the filtering portion of a semi-join subquery.
SemiJoinSubqueryExpression	Typed semi-join or anti-join subquery expression for IN and NOT IN filters.
TypeOfBuilder	Builder for Salesforce TYPEOF polymorphic relationship selections.
TypeOfElseBuilder	Completed TYPEOF builder after adding an ELSE branch.
TypeOfWhenBuilder	TYPEOF builder after adding a WHEN branch.
CompiledQuery	Compiled SOQL text paired with the immutable query AST that produced it.
QueryCompileContext	Additional schema metadata and mode supplied while compiling a query.
QueryCompiler	Compiler contract for turning a SelectQueryNode into executable SOQL.
QueryCreatorConfig	Compiler, executor, and plugin configuration for QueryCreator.
AbortableQueryOptions	Options shared by executable query builders and query executors.
QueryAbortSignal	Minimal structural contract used for query cancellation.
QueryExecutor	Execution adapter contract used by query builders and QueryCreator.
QueryId	Identifies a single query transformation/execution lifecycle.
SalesforceChildRelationship	Metadata for a Salesforce child relationship reference.
SalesforceFieldMetadata	Metadata that describes Salesforce field capabilities in a Kysoql schema.
SalesforceGeolocation	Latitude and longitude value used by Salesforce geolocation fields.
SalesforceObject	Type-level description of one Salesforce object and its query capabilities.
SalesforceParentRelationship	Metadata for a Salesforce parent relationship reference.
SalesforceQueryResult	Paginated Salesforce query response shape.
SalesforceRecordAttributes	Standard Salesforce record attributes returned by REST query responses.
SalesforceSchemaMetadata	Optional runtime metadata emitted alongside generated Salesforce schemas.
SoqlRawBuilder	A trusted SOQL fragment that is emitted verbatim by the compiler.
SoqlCurrencyLiteral	Validated ISO currency literal used in Salesforce SOQL comparisons.
SoqlLikeLiteral	LIKE operand wrapper that treats percent and underscore characters literally.
SoqlMultiSelectAnd	Represents Salesforce's semicolon-delimited multi-select picklist operand, where every listed value must be selected on the matching record.
SoqlRelativeDateLiteral	Branded Salesforce relative-date literal accepted by date and datetime filters.
SoqlDateLiteral	Validated Salesforce SOQL date literal.
SoqlDateTimeLiteral	Validated Salesforce SOQL datetime literal with an explicit UTC offset.
SoqlTimeLiteral	Validated Salesforce SOQL time literal in UTC.
KysoqlTypeError	Compile-time error marker used by fluent helpers that intentionally return an unusable type when a type assertion cannot be proven.

Type Aliases

Type Alias	Description
ApexAdditionOperand	Literal or typed Apex bind expression accepted by apexAdd().
ApexAdditionValue	Primitive value types supported by Apex addition expressions.
AggregatableFieldReference	Restricts a field reference to Salesforce fields that support aggregation.
ConvertTimezoneIdentity	Type-level identity used to track a convertTimezone() expression.
CurrencyFieldReference	Restricts a field reference to currency values supported by convertCurrency().
DateFunctionIdentity	Type-level identity used to track a date-function expression through a query.
DateGroupableFieldReference	Restricts a field reference to date or datetime fields that can be grouped.
FormattableFieldReference	Restricts a field reference to values supported by FORMAT().
NumericAggregatableFieldReference	Restricts a field reference to numeric Salesforce fields that support aggregation.
TranslatableFieldReference	Restricts a field reference to values supported by toLabel().
FilterableToLabelFieldReference	Restricts a field reference to filterable values supported by toLabel().
ToLabelFilterComparisonOperator	Comparison operators supported when filtering a toLabel() expression.
WhereExpressionFactory	Callback that builds a typed WHERE expression from an ExpressionBuilder.
FilterableFormulaFieldReference	Restricts a field reference to fields accepted by formula filter functions.
FormulaFilterComparisonOperator	Comparison operators supported by formula filter functions.
FilterableLocationFieldReference	Restricts a field reference to filterable Salesforce geolocation fields.
LocationFieldReference	Restricts a field reference to Salesforce geolocation fields.
GroupedHavingFieldName	Field names that can be referenced directly in an aggregate HAVING clause.
HavingExpressionFactory	Callback that builds a typed HAVING expression.
AggregateFunction	Salesforce aggregate function names represented in the query AST.
AggregateFunctionNode	-
AliasNode	-
AllRowsNode	-
AndNode	-
ApexAccessMode	Apex query access modes supported by Salesforce Database query methods.
ApexAccessModeNode	-
ApexBindNode	-
ApexAdditionNode	-
ApexBindExpressionNode	Immutable query AST node for a supported Apex bind expression.
ApexExpressionOperandNode	Immutable query AST node for an Apex expression operand.
ApexQueryResultNode	-
ApexSubstringNode	-
ApexLiteralNode	-
ApexLiteralValue	Primitive literal values supported inside Apex bind expressions.
BinaryOperationNode	-
ConvertCurrencyFunctionNode	-
ConvertTimezoneFunctionNode	-
DateFunction	Salesforce date and fiscal date function names supported by Kysoql.
DateFunctionArgumentNode	Immutable query AST node for a Salesforce date-function argument.
DateFunctionNode	-
DistanceDestinationNode	Immutable query AST node for the destination of a DISTANCE() expression.
DistanceFunctionNode	-
DistanceUnit	Units accepted by Salesforce DISTANCE() expressions.
FieldsFunctionNode	-
FieldsSelector	Selectors accepted by Salesforce FIELDS().
ForUpdateNode	-
ForViewReferenceMode	Salesforce FOR VIEW and FOR REFERENCE query modes.
ForViewReferenceNode	-
FormatFunctionNode	-
FormulaArithmeticOperator	Arithmetic operators supported by Salesforce formula filter functions.
FormulaFunctionNode	-
GeolocationFunctionNode	-
AdvancedGroupByMode	Advanced Salesforce GROUP BY modes supported by Kysoql.
GroupByNode	-
HavingNode	-
KnowledgeUpdateMode	Salesforce Knowledge UPDATE TRACKING and UPDATE VIEWSTAT modes.
KnowledgeUpdateNode	-
LimitNode	-
NotNode	-
OffsetNode	-
ComparisonOperator	Union of comparison operators supported by Kysoql filters.
EqualityComparisonOperator	SOQL equality comparison operators.
LikeComparisonOperator	SOQL LIKE comparison operator.
MultiSelectComparisonOperator	SOQL INCLUDES and EXCLUDES operators for multi-select picklists.
OperatorNode	-
OrderedComparisonOperator	SOQL ordered comparison operators.
SetComparisonOperator	SOQL IN and NOT IN comparison operators.
OrNode	-
OrderByDirection	Sort directions accepted by SOQL ORDER BY.
OrderByItemNode	-
OrderByNulls	NULLS FIRST and NULLS LAST modifiers accepted by SOQL ORDER BY.
OrderByNode	-
RawNode	-
RecordVisibilityContextNode	-
ReferenceNode	-
RelationshipSubqueryNode	-
SelectQueryNode	-
SelectionNode	-
SemiJoinSubqueryNode	-
SetOptionsNode	-
SObjectNode	-
ToLabelFunctionNode	-
TypeOfNode	-
UserProfileFeedWithNode	-
UsingScopeNode	-
ValueListNode	-
ValueNode	-
WhereNode	-
DataCategorySelectionNode	-
DataCategorySelector	Selectors accepted by Salesforce WITH DATA CATEGORY.
WithDataCategoryNode	-
ApexOperandValueExpression	Value accepted where a dynamic Apex expression or literal may be used.
DataCategoryInput	Input accepted when adding a Salesforce WITH DATA CATEGORY filter.
DistanceComparisonOperator	Comparison operators accepted for Salesforce DISTANCE() predicates.
RecordVisibilityContextOptions	Options for Salesforce record-visibility context clauses.
Data360AggregateSetOptionsFor	Aggregate-query SET OPTIONS shape selected from a Salesforce object capability.
Data360SetOptionsFor	SET OPTIONS shape selected from a Salesforce object capability.
ApexQueryContext	Controls how a query is rendered for static or dynamic Apex.
NoResultErrorConstructor	Error constructor accepted by executeTakeFirstOrThrow() when no row is returned.
SelectQueryMode	Tracks mutually exclusive SELECT-function and TYPEOF query modes at compile time.
SemiJoinSubqueryFactory	Callback that builds a typed semi-join or anti-join subquery.
TypeOfElseFieldList	Field list accepted by a TYPEOF ELSE branch.
TypeOfFieldList	Field list accepted by a TYPEOF WHEN branch.
SalesforceField	Describes one Salesforce field.
SalesforceFieldCustom	Extracts whether a Salesforce field is custom.
SalesforceFieldFilterValue	Extracts the value type accepted when filtering a Salesforce field.
SalesforceFieldValue	Extracts the selected runtime value type for a Salesforce field.
SalesforceObjectDataCategory	Extracts valid data-category values for a Salesforce object and group.
SalesforceObjectDataCategoryGroup	Extracts the valid data-category group names for a Salesforce object type.
SalesforceObjectFieldsComplete	Legacy structural schemas without this metadata retain their old behaviour.
SalesforceObjectMruEnabled	Extracts whether a Salesforce object supports MRU-dependent query features.
SalesforceObjectSetOptionsCapability	Extracts the SET OPTIONS capability for a Salesforce object.
SalesforceObjectSupportedScope	Extracts the USING SCOPE values supported by a Salesforce object.
SalesforceRow	Maps a Salesforce object schema to its full row value shape.
SalesforceSchema	Base shape for a Kysoql Salesforce schema.
SalesforceSetOptionsCapability	SET OPTIONS capability recorded for a generated Salesforce object schema.
SoqlRelativeDateFamily	Parameterized Salesforce relative-date literal families such as LAST_N_DAYS.
SoqlRelativeDateValue	Validated fixed or parameterized Salesforce relative-date literal value.
SoqlTemporalLiteral	Union of validated SOQL date, datetime, and time literals.
NarrowPartial	Narrows selected output properties without changing the generated SOQL.
NotNull	Marker used by `$narrowType()` to remove null from a selected field.

Variables

Variable	Description
soql	SOQL literal helpers, including the explicit unsafe raw-fragment escape hatch.

Core API reference

FunctionsCopy Anchor Link

ClassesCopy Anchor Link

InterfacesCopy Anchor Link

Type AliasesCopy Anchor Link

VariablesCopy Anchor Link

On this page

Functions

Classes

Interfaces

Type Aliases

Variables