ReferenceAPI referenceInterfaces
QueryExecutor
Generated API reference for QueryExecutor in @kysoql/core.
@kysoql/core / QueryExecutor
Execution adapter contract used by query builders and QueryCreator.
Methods
executeQuery()
executeQuery<O>(compiledQuery, options?): Promise<readonly O[]>;Executes a compiled SOQL query using normal Salesforce query semantics.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
compiledQuery | CompiledQuery<O> |
options? | AbortableQueryOptions |
Returns
Promise<readonly O[]>
executeAllQuery()?
optional executeAllQuery<O>(compiledQuery, options?): Promise<readonly O[]>;Executes a compiled query using Salesforce query-all semantics when supported.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
compiledQuery | CompiledQuery<O> |
options? | AbortableQueryOptions |
Returns
Promise<readonly O[]>
executeCountQuery()?
optional executeCountQuery(compiledQuery, options?): Promise<number>;Executes a compiled COUNT() query and returns its numeric result.
Parameters
| Parameter | Type |
|---|---|
compiledQuery | CompiledQuery<number> |
options? | AbortableQueryOptions |
Returns
Promise<number>
executeAllCountQuery()?
optional executeAllCountQuery(compiledQuery, options?): Promise<number>;Executes COUNT() using Salesforce query-all semantics when supported.
Parameters
| Parameter | Type |
|---|---|
compiledQuery | CompiledQuery<number> |
options? | AbortableQueryOptions |
Returns
Promise<number>