KysoqlKysoql
Generated API reference for Kysoql in @kysoql/core.
@kysoql/core / Kysoql
Configured query creator for building, compiling, and optionally executing typed SOQL.
Extends
QueryCreator<DB>
Type Parameters
| Type Parameter |
|---|
DB |
Constructors
Constructor
new Kysoql<DB>(configOrQueryCompiler?): Kysoql<DB>;Creates a query entry point from compiler, executor, schema metadata, and plugin configuration.
Parameters
| Parameter | Type |
|---|---|
configOrQueryCompiler | | QueryCompiler | QueryCreatorConfig |
Returns
Kysoql<DB>
Inherited from
Methods
withPlugin()
withPlugin(plugin): this;Returns a QueryCreator with the plugin appended to the execution pipeline.
Parameters
| Parameter | Type |
|---|---|
plugin | KysoqlPlugin |
Returns
this
Inherited from
withoutPlugins()
withoutPlugins(): this;Returns a QueryCreator with all plugins removed.
Returns
this
Inherited from
selectFrom()
selectFrom<TB>(from): SelectQueryBuilder<DB, TB, unknown, "plain">;Starts a typed query for the specified Salesforce object.
Type Parameters
| Type Parameter |
|---|
TB extends string |
Parameters
| Parameter | Type |
|---|---|
from | TB |
Returns
SelectQueryBuilder<DB, TB, unknown, "plain">
Inherited from
executeQuery()
Executes a supplied operation tree through this creator's compiler, plugins, and executor.
Call Signature
executeQuery(compiledQuery, options?): Promise<number>;Executes a supplied operation tree through this creator's compiler, plugins, and executor.
Parameters
| Parameter | Type |
|---|---|
compiledQuery | CompiledQuery<number> |
options? | AbortableQueryOptions |
Returns
Promise<number>
Inherited from
Call Signature
executeQuery<O>(compiledQuery, options?): Promise<readonly O[]>;Executes a supplied operation tree through this creator's compiler, plugins, and executor.
Type Parameters
| Type Parameter |
|---|
O |
Parameters
| Parameter | Type |
|---|---|
compiledQuery | CompiledQuery<O> |
options? | AbortableQueryOptions |
Returns
Promise<readonly O[]>