kysely-tables

The kysely-tables project provides a unified approach to managing SQL databases by utilizing the same Kysely types for defining your table schema, executing migrations, and processing queries. This innovative solution eliminates the need for intermediary schema-defining APIs or languages, streamlining the development process.

Key Features:

• Single Source of Truth: Utilize your Kysely types as the primary reference for creating CREATE TABLE statements. This ensures consistency across your database schema, migrations, and queries.
• No Database Connection Required for Schema Retrieval: Eliminates the need to connect to the database just to access your schema structure, enhancing efficiency.
• Simplified Setup: Avoids the complexity that comes with integrating multiple database libraries, allowing for a cleaner, more effective development workflow.

Annotation Types and SQL Generation

The project focuses on an innovative use of annotation types that enhance standard Kysely types while maintaining their original capabilities. These annotations work in conjunction with a processing tool to automatically generate SQL schemas and migrations by analyzing schema changes.

Getting Started

To use this library, inspect the db.ts file in the examples for a clear picture of how table definitions align with Kysely's expectations. For example:

export interface UsersTable {
    id: Generated<Primary<number>>
    name: Sized<string, 100> | null
    email: Unique<Sized<string, 255>>
    passwordHash: Text<string>
    role: Default<string, "'member'">
    createdAt: Default<Date, 'now()'>
    updatedAt: Default<Date, 'now()'>
    deletedAt: null | Date 
}

In this setup, types such as Generated, Primary, and Unique are fully compatible with Kysely and facilitate efficient schema generation.

Migration Process

The migration process is intuitive—simply modify the db.ts file to reflect changes and run a command to generate a new migration.

% tsx db.ts --revision

This operation outputs migration files which can be executed to keep your database schema in sync with your application logic.

Internals and Contributions

Built with simplicity in mind, kysely-tables offers a lightweight yet effective architecture that inspires confidence in database management. Those interested in contributing to the project are encouraged to report bugs and suggest features.

For further details, please refer to the comprehensive blog post associated with the project.