@storecraft/database-sql-base/types.public.d.ts

Official SQL Database driver for storecraft

import type { Dialect } from 'kysely';

export { SQL } from './index.js';

export type SqlDialectType = 'SQLITE' | 'POSTGRES' | 'MYSQL';

/**
 * The Storecraft SQL config
 */
export type Config<DialectType extends Dialect = Dialect> = {
  /**
   * @description Database name
   * 
   * @default main
   */
  db_name?: string,

  /**
   * @description The `Kysely` dialect
   */
  dialect: DialectType,

  /**
   * @description The type of the sql dialect `SQLITE`, `POSTGRES`, `MYSQL`
   */
  dialect_type: SqlDialectType;
}