Improve do qb (#54)

docs/mkdocs.yml

@@ -36,6 +36,8 @@ nav:
   - getting-started.md
   - type-check.md
   - basic-queries.md
+  - modular-selects.md
+  - utility-methods.md
   - Advanced Queries:
       - advanced-queries/fields.md
       - advanced-queries/join.md
@@ -50,6 +52,7 @@ nav:
       - advanced-queries/raw-sql.md
   - Supported Databases:
       - databases/cloudflare-d1.md
+      - databases/cloudflare-do-srs.md
       - databases/postgresql.md
       - databases/bring-your-own-database.md
 markdown_extensions:

docs/pages/databases/cloudflare-do-srs.md

@@ -0,0 +1,19 @@
+## Write queries within your DO
+
+```ts
+import { DOQB } from 'workers-qb'
+
+export class DOSRS extends DurableObject {
+  async getEmployees() {
+    const qb = new DOQB(this.ctx.storage.sql)
+
+    const fetched = await qb
+      .fetchAll({
+        tableName: 'employees',
+      })
+      .execute()
+
+    return fetched.results
+  }
+}
+```

docs/pages/modular-selects.md

@@ -0,0 +1,52 @@
+You can now chain select parameters just like a normal ORM.
+You can chain how many parameters as you would like.
+
+For example this "normal" fetchAll query:
+
+```ts
+const qb = new D1QB(env.DB)
+
+const result = await qb
+  .fetchAll({
+    tableName: 'testTable',
+    fields: ['id', 'name'],
+    where: {
+      conditions: 'field = ?1',
+      params: ['test'],
+    },
+    join: {
+      type: JoinTypes.LEFT,
+      table: 'employees',
+      on: 'testTable.employee_id = employees.id',
+    },
+  })
+  .execute()
+```
+
+Could be re-written like this:
+
+```ts
+const qb = new D1QB(env.DB)
+
+const result = await qb
+  .select('testTable')
+  .fields(['id', 'name'])
+  .where('field = ?1', 'test')
+  .join({ type: JoinTypes.LEFT, table: 'employees', on: 'testTable.employee_id = employees.id' })
+  .execute()
+```
+
+Count method is also available for the modular selects
+
+```ts
+const qb = new D1QB(env.DB)
+
+const result = await qb
+  .select('testTable')
+  .fields(['id', 'name'])
+  .where('field = ?1', 'test')
+  .join({ type: JoinTypes.LEFT, table: 'employees', on: 'testTable.employee_id = employees.id' })
+  .count()
+
+console.log(`Total results: ${result.results.total}`)
+```

docs/pages/utility-methods.md

@@ -0,0 +1,27 @@
+On selects, you have the option to `.count()` the rows without having to build a new query everytime.
+
+```ts
+import { OrderTypes } from 'workers-qb'
+const qb = new D1QB(env.DB)
+
+type EmployeeRoles = {
+  role: string
+  count: number
+}
+
+async function listEmployees(page = 0) {
+  const qs = qb.fetchAll<EmployeeRoles>({
+    tableName: 'employees',
+    limit: 20,
+    offset: page * 20,
+  })
+
+  const thisPageEmployees = await qs.execute()
+  const employeeCount = await qs.count()
+
+  return {
+    employees: thisPageEmployees.results,
+    total: employeeCount.results.total,
+  }
+}
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "workers-qb",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "Zero dependencies Query Builder for Cloudflare Workers",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/databases/do.ts

@@ -3,8 +3,7 @@ import { SqlStorageCursor, type SqlStorage } from '@cloudflare/workers-types/exp
 import { Query } from '../tools'
 import { FetchTypes } from '../enums'
 
-// There's no wrapper because DO databases return the Cursor to be consumed
-export class DurableObjectDatabaseQB extends QueryBuilder<{}> {
+export class DOQB extends QueryBuilder<{}> {
   public db: SqlStorage
 
   constructor(db: SqlStorage) {
@@ -27,7 +26,6 @@ export class DurableObjectDatabaseQB extends QueryBuilder<{}> {
       let stmt = this.db.prepare(query.query)
       // @ts-expect-error Their types appear to be wrong here
       const result = stmt(...query.arguments) as SqlStorageCursor
-      //FIXME: not efficient but the iterator that SRS is weird and I can only get it with a object form this way
       if (query.fetchType == FetchTypes.ONE) {
         return {
           results: Array.from(result)[0],
@@ -43,7 +41,6 @@ export class DurableObjectDatabaseQB extends QueryBuilder<{}> {
     const cursor = this.db.exec(query.query)
 
     if (query.fetchType == FetchTypes.ONE) {
-      //FIXME: not efficient but the iterator that SRS is weird and I can only get it with a object form this way
       return {
         results: Array.from(cursor)[0],
       }
@@ -55,3 +52,6 @@ export class DurableObjectDatabaseQB extends QueryBuilder<{}> {
     }
   }
 }
+
+// Deprecated class name
+export class DurableObjectDatabaseQB extends DOQB {}