docs(builder, utils): add soft delete docs

Author: subframe7536

packages/sqlite-builder/README.md

@@ -32,6 +32,8 @@ choose [NodeWasmDialect](../dialect-wasm/README.md#nodewasmdialect)
 ### Define / Initialize
 
 ```ts
+import { SqliteDialect } from 'kysely'
+import Database from 'better-sqlite3'
 import { SqliteBuilder } from 'kysely-sqlite-builder'
 import { Column, defineTable, useSchema } from 'kysely-sqlite-builder/schema'
 import type { InferDatabase } from 'kysely-sqlite-builder/schema'
@@ -127,7 +129,42 @@ using selectWithUsing = db.precompile<{ name: string }>()
   )
 ```
 
-### Utils
+### Soft delete
+
+```ts
+import { SqliteDialect } from 'kysely'
+import Database from 'better-sqlite3'
+import type { InferDatabase } from 'sqlite-builder/schema'
+import { Column, defineTable, useSchema } from 'sqlite-builder/schema'
+import { SqliteBuilder } from 'sqlite-builder'
+import { createSoftDeleteExecutorFn } from 'sqlite-builder/utils'
+
+const softDeleteTable = defineTable({
+  id: Column.Increments(),
+  name: Column.String(),
+}, {
+  primary: 'id',
+  softDelete: true,
+})
+const softDeleteSchema = {
+  testSoftDelete: softDeleteTable,
+}
+
+const db = new SqliteBuilder<InferDatabase<typeof softDeleteSchema>>({
+  dialect: new SqliteDialect({
+    database: new Database(':memory:'),
+    async onCreateConnection(connection) {
+      await optimizePragma(connection)
+    },
+  }),
+  executorFn: createSoftDeleteExecutorFn(),
+})
+
+await db.executeTakeFirst(d => d.deleteFrom('testSoftDelete').where('id', '=', 1))
+// update "testSoftDelete" set "isDeleted" = 1 where "id" = 1
+```
+
+## Utils
 
 in `kysely-sqlite-builder/utils`
 

packages/sqlite-utils/README.md

@@ -52,12 +52,21 @@ function createPrecompile<T extends Record<string, any>>(options?: PrecompileOpt
 //     paramBuilder: ({ param, qb }: SetParam<O, T>) => Compilable<O>
 //   ) => CompileFn<O, T>
 // }
+
+// create a wrapper for soft delete
+function createSoftDeleteExecutorFn<DB extends Record<string, any>>(deleteColumnName?: string): SqliteExecutorFn<DB, {
+  withoutDelete: <W extends WhereInterface<DB, keyof DB>>(qb: W) => WhereInterface<DB, keyof DB>
+}>
 ```
 
 ## Credit
 
 - [kysely-params](https://github.com/jtlapp/kysely-params)
 
+## Todo
+
+- [ ] improve docs
+
 ## license
 
 MIT

packages/sqlite-utils/src/soft-delete.ts

@@ -12,6 +12,9 @@ export type SqliteExecutor<DB extends Record<string, any>, Extra extends Record<
   selectFrom: Kysely<DB>['selectFrom']
   insertInto: Kysely<DB>['insertInto']
   updateTable: Kysely<DB>['updateTable']
+  /**
+   * see {@link Kysely.deleteFrom}
+   */
   deleteFrom: {
     <TR extends keyof DB & string>(from: TR): Omit<DeleteQueryBuilder<DB, ExtractTableAlias<DB, TR>, DeleteResult>, JoinFnName>
     <TR extends TableReference<DB>>(table: TR): Omit<DeleteQueryBuilder<From<DB, TR>, FromTables<DB, never, TR>, DeleteResult>, JoinFnName>