feat: increase query performance and add fail option

etienne-bechara · Apr 23, 2021 · 97324eb · 97324eb
1 parent 3b4e343
commit 97324eb
Show file tree

Hide file tree

Showing 6 changed files with 130 additions and 112 deletions.
diff --git a/README.md b/README.md
@@ -123,17 +123,15 @@ export class UserService extends OrmService<UserEntity> {
 
 At this point, you may inject you `UserService` in any order provider and have its methods available to you:
 ```ts
-readById(id: string, options: OrmReadOptions<Entity> = { }): Entity
-
-readUnique(params: OrmReadParams<Entity>, options: OrmReadOptions<Entity> = { }): Entity
-
-readAndCount(params: OrmReadParams<Entity>, options: OrmReadOptions<Entity> = { }): OrmPaginatedResponse<Entity>
-
-updateById(id: string, data: EntityData<Entity>): Entity
-
-resert(data: EntityData<Entity>, uniqueKey?: string[]): Entity 
-
-upsert(data: EntityData<Entity>, uniqueKey?: string[]): Entity
+readById(id: string, options: OrmReadOptions<Entity> = { }): Entity;
+readByIdOrFail(id: string, options: OrmReadOptions<Entity> = { }): Entity;
+readUnique(params: OrmReadParams<Entity>, options: OrmReadOptions<Entity> = { }): Entity;
+readUniqueOrFail(params: OrmReadParams<Entity>, options: OrmReadOptions<Entity> = { }): Entity;
+readAndCount(params: OrmReadParams<Entity>, options: OrmReadOptions<Entity> = { }): OrmPaginatedResponse<Entity>;
+updateById(id: string, data: EntityData<Entity>): Entity;
+removeById(id: string): Entity;
+resert(data: EntityData<Entity>, uniqueKey?: string[]): Entity;
+upsert(data: EntityData<Entity>, uniqueKey?: string[]): Entity;
 ```
 
 ### Creating an Entity Controller

diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
   },
   "devDependencies": {
     "@bechara/eslint-config-bechara-ts": "1.1.3",
-    "@bechara/nestjs-core": "2.0.17",
+    "@bechara/nestjs-core": "2.0.19",
     "@commitlint/cli": "12.1.1",
     "@commitlint/config-conventional": "12.1.1",
     "@mikro-orm/mysql": "4.5.3",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/source/orm/orm.interface/orm.read.options.ts b/source/orm/orm.interface/orm.read.options.ts
@@ -5,4 +5,5 @@ import { OrmQueryOrder } from '../orm.enum';
 export interface OrmReadOptions<Entity> extends FindOptions<Entity> {
   sort?: string;
   order?: OrmQueryOrder;
+  findOrFail?: boolean;
 }
diff --git a/source/orm/orm.interface/orm.upsert.options.ts b/source/orm/orm.interface/orm.upsert.options.ts
@@ -1,4 +1,6 @@
-export interface OrmUpsertOptions {
+import { OrmReadOptions } from './orm.read.options';
+
+export interface OrmUpsertOptions<Entity> extends OrmReadOptions<Entity> {
   uniqueKey?: string[];
   allowUpdate?: boolean;
   disallowRetry?: boolean;