feat(query-builder): allow awaiting the QueryBuilder instance

[B4nan]

Since v5 we can await the QueryBuilder instance, which will automatically execute the QB and return appropriate response. The QB instance is now typed based on usage of select/insert/update/delete/truncate methods to one of:

• SelectQueryBuilder
  • awaiting yields array of entities (as qb.getResultList())
• CountQueryBuilder
  • awaiting yields number (as qb.getCount())
• InsertQueryBuilder (extends RunQueryBuilder)
  • awaiting yields QueryResult
• UpdateQueryBuilder (extends RunQueryBuilder)
  • awaiting yields QueryResult
• DeleteQueryBuilder (extends RunQueryBuilder)
  • awaiting yields QueryResult
• TruncateQueryBuilder (extends RunQueryBuilder)
  • awaiting yields QueryResult

const res1 = await em.qb(Publisher).insert({
  name: 'p1',
  type: PublisherType.GLOBAL,
});
// res1 is of type `QueryResult<Publisher>`
console.log(res1.insertId);

const res2 = await em.qb(Publisher)
        .select('*')
        .where({ name: 'p1' })
        .limit(5);
// res2 is Publisher[]
console.log(res2.map(p => p.name));

const res3 = await em.qb(Publisher).count().where({ name: 'p1' });
// res3 is number
console.log(res3 > 0);

const res4 = await em.qb(Publisher)
        .update({ type: PublisherType.LOCAL })
        .where({ name: 'p1' });
// res4 is QueryResult<Publisher>
console.log(res4.affectedRows > 0);

const res5 = await em.qb(Publisher).delete().where({ name: 'p1' });
// res4 is QueryResult<Publisher>
console.log(res4.affectedRows > 0);
expect(res5.affectedRows > 0).toBe(true); // test the type

[codecov-commenter]

Codecov Report

Merging #2446 (ab4d359) into master (c7a75e0) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master     #2446   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          190       190           
  Lines        10768     10788   +20     
  Branches      2460      2468    +8     
=========================================
+ Hits         10768     10788   +20     

Impacted Files	Coverage Δ
packages/knex/src/SqlEntityManager.ts	100.00% <100.00%> (ø)
packages/knex/src/SqlEntityRepository.ts	100.00% <100.00%> (ø)
packages/knex/src/query/QueryBuilder.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c7a75e0...ab4d359. Read the comment docs.