KysoqlReferenceAPI referenceInterfaces
KysoqlPlugin
Generated API reference for KysoqlPlugin in @kysoql/core.
@kysoql/core / KysoqlPlugin
Hook contract for transforming Kysoql query trees and execution results.
Query transforms run in registration order before compilation. Result transforms run in the same order after the configured executor resolves.
Methods
transformQuery()
transformQuery(args): SelectQueryNode;Transforms an operation tree before compilation. Return the original node when no change is needed.
Parameters
| Parameter | Type |
|---|---|
args | PluginTransformQueryArgs |
Returns
transformResult()?
optional transformResult<Result>(args): Result | Promise<Result>;Transforms an executor result after the query completes.
Type Parameters
| Type Parameter |
|---|
Result |
Parameters
| Parameter | Type |
|---|---|
args | PluginTransformResultArgs<Result> |
Returns
Result | Promise<Result>