feat(sql): add qb.raw() to allow using raw snippets in QB

Allows to do things like `qb.update({ price: qb.raw('price + 1') }).where({ uuid: '123' });`. Related: #598
mikro-orm · Aug 9, 2020 · c09a5b6 · c09a5b6
1 parent 47f899e
commit c09a5b6
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/docs/docs/query-builder.md b/docs/docs/query-builder.md
@@ -280,6 +280,18 @@ console.log(qb4.getQuery());
 // select `a`.* from `author2` as `a` where (select count(distinct `b`.`uuid_pk`) as `count` from `book2` as `b` where `b`.`author_id` = `a`.`id`) = ?
 ```
 
+## Referring to column in update queries
+
+You can use `qb.raw()` to insert raw SQL snippets like this:
+
+```typescript
+const qb = orm.em.createQueryBuilder(Book);
+qb.update({ price: qb.raw('price + 1') }).where({ uuid: '123' });
+
+console.log(qb.getQuery());
+// update `book` set `price` = price + 1 where `uuid_pk` = ?
+```
+
 ## Locking support
 
 ```typescript
@@ -318,5 +330,6 @@ qb.getSingleResult<T>(): T;
 qb.setLockMode(mode: LockMode): QueryBuilder;
 qb.getQuery(): string;
 qb.getParams(): any[];
+qb.raw(sql): Raw;
 qb.clone(): QueryBuilder;
 ```
diff --git a/packages/knex/src/query/QueryBuilder.ts b/packages/knex/src/query/QueryBuilder.ts
@@ -182,6 +182,10 @@ export class QueryBuilder<T extends AnyEntity<T> = AnyEntity> {
     return this.knex.ref(field);
   }
 
+  raw(sql: string): Raw {
+    return this.knex.raw(sql);
+  }
+
   limit(limit?: number, offset = 0): this {
     this._limit = limit;
 

diff --git a/packages/knex/src/query/QueryBuilderHelper.ts b/packages/knex/src/query/QueryBuilderHelper.ts
@@ -70,7 +70,7 @@ export class QueryBuilderHelper {
         return;
       }
 
-      if (!prop.customType && (Array.isArray(data[k]) || Utils.isObject(data[k], [Date]))) {
+      if (!prop.customType && (Array.isArray(data[k]) || Utils.isPlainObject(data[k]))) {
         data[k] = JSON.stringify(data[k]);
       }
 

diff --git a/tests/QueryBuilder.test.ts b/tests/QueryBuilder.test.ts
@@ -1062,6 +1062,13 @@ describe('QueryBuilder', () => {
     expect(qb.getParams()).toEqual(['test 123', PublisherType.GLOBAL, 123, PublisherType.LOCAL]);
   });
 
+  test('update query with column reference', async () => {
+    const qb = orm.em.createQueryBuilder(Book2);
+    qb.update({ price: qb.raw('price + 1') }).where({ uuid: '123' });
+    expect(qb.getQuery()).toEqual('update `book2` set `price` = price + 1 where `uuid_pk` = ?');
+    expect(qb.getParams()).toEqual(['123']);
+  });
+
   test('update query with auto-joining', async () => {
     const qb = orm.em.createQueryBuilder(Publisher2);
     qb.update({ name: 'test 123', type: PublisherType.GLOBAL }).where({ books: { author: 123 } });