KysoqlAPI referenceInterfaces
RestExecutor
Generated API reference for RestExecutor in @kysoql/rest.
@kysoql/rest / RestExecutor
Query executor backed by the Salesforce REST API.
Extends
QueryExecutor
Methods
executeQuery()
executeQuery<O>(query, options?): Promise<readonly O[]>;Executes the query through /query and follows all result pages.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
query | CompiledQuery<O> |
options? | RestRequestOptions |
Returns
Promise<readonly O[]>
Overrides
QueryExecutor.executeQueryexecuteAllQuery()
executeAllQuery<O>(query, options?): Promise<readonly O[]>;Executes the query through /queryAll and follows all result pages.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
query | CompiledQuery<O> |
options? | RestRequestOptions |
Returns
Promise<readonly O[]>
Overrides
QueryExecutor.executeAllQueryexecuteCountQuery()
executeCountQuery(query, options?): Promise<number>;Executes COUNT() through /query and returns the count.
Parameters
| Parameter | Type |
|---|---|
query | CompiledQuery<number> |
options? | RestRequestOptions |
Returns
Promise<number>
Overrides
QueryExecutor.executeCountQueryexecuteAllCountQuery()
executeAllCountQuery(query, options?): Promise<number>;Executes COUNT() through /queryAll and returns the count.
Parameters
| Parameter | Type |
|---|---|
query | CompiledQuery<number> |
options? | RestRequestOptions |
Returns
Promise<number>
Overrides
QueryExecutor.executeAllCountQueryqueryPages()
queryPages<O>(query, options?): AsyncIterableIterator<RestQueryPage<O>>;Streams validated root query pages while hydrating relationship subquery continuations.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
query | CompiledQuery<O> |
options? | RestQueryOptions |
Returns
AsyncIterableIterator<RestQueryPage<O>>
iterateQuery()
iterateQuery<O>(query, options?): AsyncIterableIterator<O>;Streams individual records from queryPages() without collecting the full result set.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
query | CompiledQuery<O> |
options? | RestQueryOptions |
Returns
AsyncIterableIterator<O>