Libraries
    Preparing search index...

    Interface OrmCliConfig

    Shape of the default export expected in db.config.ts.

    // db.config.ts
    import { defineConfig } from '@cleverbrush/orm-cli';
    import knex from './src/db/knex.js';
    import { UserEntity, TodoEntity } from './src/db/schemas.js';

    export default defineConfig({
        knex,
        entities: { users: UserEntity, todos: TodoEntity },
        migrations: { directory: './migrations' },
    });
    interface OrmCliConfig {
        entities: Record<string, Entity<any, any>>;
        knex: Knex;
        migrations: MigrationsConfig;
    }
    Index

    Properties

    entities knex migrations

    Properties

    entities: Record<string, Entity<any, any>>

    Map of entity name to Entity definition. The same map you pass to createDb() from @cleverbrush/orm.

    knex: Knex

    A live Knex instance connected to your database.

    migrations: MigrationsConfig

    Migration configuration.

    Settings

    Member Visibility

    On This Page

    Properties