Interface KyselyPlugin

Hierarchy

  • KyselyPlugin

Implemented by

Methods

  • This is called for each query before it is executed. You can modify the query by transforming its OperationNode tree provided in args.node and returning the transformed tree. You'd usually want to use an OperationNodeTransformer for this.

    If you need to pass some query-related data between this method and transformResult you can use a WeakMap with args.queryId as the key:

    const plugin = {
    data: new WeakMap<QueryId, SomeData>(),

    transformQuery(args: PluginTransformQueryArgs): RootOperationNode {
    this.data.set(args.queryId, something)
    return args.node
    },

    transformResult(args: PluginTransformResultArgs): QueryResult<UnknownRow> {
    const data = this.data.get(args.queryId)
    return args.result
    }
    }

    You should use a WeakMap instead of a Map or some other strong references because transformQuery is not always matched by a call to transformResult which would leave orphaned items in the map and cause a memory leak.

    Parameters

    Returns RootOperationNode

Generated using TypeDoc