@storecraft/database-mysql v1.3.0

Storecraft MySQL driver

Official MySQL driver for StoreCraft using mysql2 package.

npm i @storecraft/database-mysql

usage

import 'dotenv/config';
import http from "node:http";
import { App } from '@storecraft/core'
import { NodePlatform } from '@storecraft/core/platform/node';
import { NodeLocalStorage } from '@storecraft/core/storage/node'
import { MySQL } from '@storecraft/database-mysql';
import { migrateToLatest } from '@storecraft/database-sql-base/migrate.js'

const app = new App(
  {
    auth_admins_emails: ['admin@sc.com'],
  }
)
.withPlatform(new NodePlatform())
.withDatabase(
  new MySQL(
    {
      pool_options: {
        database: process.env.MYSQL_DATABASE,
        host: process.env.MYSQL_HOST,
        port: parseInt(process.env.MYSQL_PORT),
        user: process.env.MYSQL_USER,
        password: process.env.MYSQL_PASSWORD,
      }
    }
  )
)
.withStorage(new NodeLocalStorage('storage'))
.init();

await migrateToLatest(app.__show_me_everything.db, false);
await app.__show_me_everything.vector_store?.createVectorIndex();

http.createServer(app.handler).listen(
  8000,
  () => {
    app.print_banner('http://localhost:8000');
  }
); 

Storecraft will search the following env variables

MYSQL_USER=root
MYSQL_PASSWORD=password
MYSQL_DATABASE=main
MYSQL_PORT=3306
MYSQL_HOST=localhost

So, you can instantiate with empty config

.withDatabase(
  new MySQL()
)

Testing Locally

1. First start a mysql server First, make sure you have docker installed, Then, run

npm run database-mysql:docker-compose-up

2. create Environment

create .env file with

MYSQL_USER=root
MYSQL_PASSWORD=password
MYSQL_DATABASE=main
MYSQL_PORT=3306
MYSQL_HOST=localhost

3. Run tests/runner.test.js

npm run database-mysql:test

Author: Tomer Shalev <tomer.shalev@gmail.com>