Kysely Query Hooks

Introduction

Kysely query hooks are the lowest level of interceptor in the plugin system. Since ZenStack eventually delegates all database access to Kysely, these hooks allow you to inspect and alter all SQL queries before they are sent to the database, regardless of whether they originate from the ORM query API or the query builder API.

This mechanism gives you great power to entirely control the ORM's behavior. One good example is the access policy - the access policy enforcement is entirely achieved via intercepting the Kysely queries.

To create a Kysely query hook plugin, call the $use method with an object containing a onKyselyQuery callback. The callback is triggered before each Kysely query is executed. It receives a context object containing:

• The Kysely instance
• The Kysely query node (SQL AST)
• The ORM client that triggered the query
• A "proceed query" function, which you can call to send the query to the database

Samples

info

Kysely's QueryNode objects are low-level and not easy to process. ZenStack will provide helpers to facilitate common tasks in the future.

Interactive Sample

Click here to pop out if the embed doesn't load an interactive terminal.

Plain Code

plugins/kysely-query-hooks.ts

Loading...