feat(builder)!: rename updateTableSchema to syncDB

Author: subframe7536

packages/sqlite-builder/README.md

@@ -65,14 +65,14 @@ const db = new SqliteBuilder<DB>({
   onQuery: true,
 })
 
-// update tables using syncTable
-await db.updateTableSchema(useSchema(baseTables, { logger: false }))
+// update table using schema
+await db.syncDB(useSchema(baseTables, { logger: false }))
 
 import { useMigrator } from 'kysely-sqlite-builder'
 import { FileMigrationProvider } from 'kysely'
 
 // update tables using MigrationProvider and migrate to latest
-await db.updateTableSchema(useMigrator(new FileMigrationProvider(/* ... */)))
+await db.syncDB(useMigrator(new FileMigrationProvider(/* ... */)))
 ```
 
 ### Usage
@@ -82,21 +82,20 @@ await db.updateTableSchema(useMigrator(new FileMigrationProvider(/* ... */)))
 await db.transaction(async (trx) => {
   // use transaction
   await trx.insertInto('test').values({ gender: false }).execute()
+  // auto use `trx`
+  await db.execute(d => d.insertInto('test').values({ gender: true }).execute())
   // nest transaction, using savepoint
   await db.transaction(async () => {
-    // auto load transaction with savepoint
-    await db.execute(
-      d => d.selectFrom('test').where('gender', '=', true),
-      'this is error message'
-    )
+    // auto use savepoint
+    await db.execute(d => d.selectFrom('test').where('gender', '=', true))
   })
 })
 
 // use origin instance
 await db.kysely.insertInto('test').values({ gender: false }).execute()
 
 // run raw
-await db.raw(sql`PRAGMA user_version = 2`, 'this is error message')
+await db.raw(sql`PRAGMA user_version = 2`)
 
 // destroy
 await db.destroy()

packages/sqlite-builder/src/builder.ts

@@ -124,16 +124,16 @@ export class SqliteBuilder<DB extends Record<string, any>> {
    *   onQuery: true,
    * })
    *
-   * // update tables using syncTable
-   * await db.updateTableSchema(useSchema(baseTables, { logger: false }))
+   * // update tables using schema
+   * await db.syncDB(useSchema(baseTables, { logger: false }))
    *
    * import { useMigrator } from 'kysely-sqlite-builder'
    * import { FileMigrationProvider } from 'kysely'
    *
    * // update tables using MigrationProvider and migrate to latest
-   * await db.updateTableSchema(useMigrator(new FileMigrationProvider(...)))
+   * await db.syncDB(useMigrator(new FileMigrationProvider(...)))
    */
-  public async updateTableSchema(updater: TableUpdater, checkIntegrity?: boolean): Promise<StatusResult> {
+  public async syncDB(updater: TableUpdater, checkIntegrity?: boolean): Promise<StatusResult> {
     try {
       if (checkIntegrity && !(await runCheckIntegrity(this.kysely))) {
         this.logger?.error('integrity check fail')

test/builder.test.ts

@@ -40,15 +40,15 @@ describe('test sync table', async () => {
   let db: SqliteBuilder<any>
   beforeEach(async () => {
     db = getDatabase()
-    await db.updateTableSchema(useSchema(baseTables, { log: false }))
+    await db.syncDB(useSchema(baseTables, { log: false }))
   })
   it('should create new table', async () => {
     const foo = defineTable({
       col1: { type: 'increments' },
       col2: { type: 'string' },
     })
 
-    await db.updateTableSchema(useSchema({
+    await db.syncDB(useSchema({
       ...baseTables,
       foo,
     }, { log: false }))
@@ -59,7 +59,7 @@ describe('test sync table', async () => {
     expect(_tables[1].name).toBe('test')
   })
   it('should drop old table', async () => {
-    await db.updateTableSchema(useSchema({ }, { log: false }))
+    await db.syncDB(useSchema({ }, { log: false }))
 
     const _tables = await db.kysely.introspection.getTables()
     expect(_tables.length).toBe(0)
@@ -78,7 +78,7 @@ describe('test sync table', async () => {
         timeTrigger: { create: true, update: true },
       },
     )
-    await db.updateTableSchema(useSchema({ test: foo }, { log: false }))
+    await db.syncDB(useSchema({ test: foo }, { log: false }))
     const [_tables] = await db.kysely.introspection.getTables()
     expect(_tables
       .columns
@@ -100,7 +100,7 @@ describe('test sync table', async () => {
 describe('test builder', async () => {
   const db = getDatabase()
   await getOrSetDBVersion(db.kysely, 2)
-  await db.updateTableSchema(useSchema(baseTables))
+  await db.syncDB(useSchema(baseTables))
   it('should insert', async () => {
     //  generate table
     console.log(await db.transaction(async () => {