KysoqlReferenceAPI referenceInterfaces
RelationshipSubqueryPilotModule
Generated API reference for RelationshipSubqueryPilotModule in @kysoql/core.
@kysoql/core / RelationshipSubqueryPilotModule
Pilot-only features available while building a relationship subquery.
Type Parameters
| Type Parameter | Default type |
|---|---|
DB | - |
TB extends keyof DB | - |
O | - |
Depth extends ParentToChildDepth | readonly [unknown] |
FunctionMode extends RelationshipSubqueryFunctionMode | "none" |
ApexMode extends boolean | false |
Methods
offset()
offset(offset): RelationshipSubqueryBuilder<DB, TB, O, Depth, FunctionMode, ApexMode>;Opts into Salesforce's relationship-subquery OFFSET pilot, which Salesforce says is not intended for production. The compiler requires the immediate parent query to use a literal LIMIT 1.
Parameters
| Parameter | Type |
|---|---|
offset | number |
Returns
RelationshipSubqueryBuilder<DB, TB, O, Depth, FunctionMode, ApexMode>
clearOffset()
clearOffset(): RelationshipSubqueryBuilder<DB, TB, O, Depth, FunctionMode, ApexMode>;Returns a builder with the OFFSET clause removed.
Returns
RelationshipSubqueryBuilder<DB, TB, O, Depth, FunctionMode, ApexMode>