Objection.js EntityTraversal / CatDatabase

Author: llouka

src/Packages/objection/src/Benchmarks/EntityTraversal.ts

@@ -1,19 +1,30 @@
-import { Skipped } from 'BenchmarkUtils/BenchmarkRunner'
 import { EntityTraversalTest } from 'Benchmarks/EntityTraversal'
-import { Cats } from '../Databases/CatDatabase/Cats'
+import { Cat } from '../Databases/CatDatabase/Cat'
+import { Toy } from '../Databases/CatDatabase/Toy'
 
 const EntityTraversal: EntityTraversalTest = {
   getCatColor: async id => {
-    return Cats.query()
+    return Cat.query()
       .findById(id)
       .withGraphFetched('catColor.colorHex')
-      .then(cat => (cat as any)?.catColor?.colorHex?.hexCode ?? '')
+      .then(cat => {
+        return cat?.catColor?.colorHex?.hexCode ?? ''
+      })
   },
   countCatsByColor: async (hexColor: string) => {
-    throw new Skipped()
+    return Cat.query()
+      .count()
+      .joinRelated('catColor.colorHex')
+      .where('hex_code', hexColor)
+      .first()
+      .then((result: any) => Number(result.count))
   },
   getToysAvailableToCat: async (id: number) => {
-    throw new Skipped()
+    return Toy.query()
+      .joinRelated('houses')
+      .joinRelated('houses.cats')
+      .where('houses:cats.id', id)
+      .then(toys => toys.map(toy => toy.toyName))
   },
 }
 

src/Packages/objection/src/Databases/CatDatabase/Cats.ts renamed to src/Packages/objection/src/Databases/CatDatabase/Cat.ts

@@ -1,9 +1,16 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { Model } from 'objection'
+import { CatColor } from './CatColor'
+
+export class Cat extends Model {
+  id!: number
+  catColorId!: number
+  catName!: string
+  dateOfBirth!: Date
+  catColor?: CatColor
 
-export class Cats extends Model {
   static get tableName() {
-    return 'cats'
+    return 'cat'
   }
 
   static get idColumn() {
@@ -24,28 +31,28 @@ export class Cats extends Model {
   }
 
   static get relationMappings() {
-    const { CatColors } = require('./CatColors')
+    const { CatColor } = require('./CatColor')
     const { House } = require('./House')
 
     return {
       catColor: {
         relation: Model.BelongsToOneRelation,
-        modelClass: CatColors,
+        modelClass: CatColor,
         join: {
-          from: 'cats.cat_color_id',
-          to: 'cat_colors.id',
+          from: 'cat.catColorId',
+          to: 'catColor.id',
         },
       },
       houses: {
         relation: Model.ManyToManyRelation,
         modelClass: House,
         join: {
-          from: 'cats.id',
+          from: 'cat.id',
           through: {
-            from: 'house_cats.cat_id',
-            to: 'house_cats.house_id',
+            from: 'houseCat.catId',
+            to: 'houseCat.houseId',
           },
-          to: 'houses.id',
+          to: 'house.id',
         },
       },
     }

src/Packages/objection/src/Databases/CatDatabase/CatColors.ts renamed to src/Packages/objection/src/Databases/CatDatabase/CatColor.ts

@@ -1,9 +1,16 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { Model } from 'objection'
+import { ColorHex } from './ColorHex'
+import { Cat } from './Cat'
+
+export class CatColor extends Model {
+  id: number
+  name: string
+  colorHex?: ColorHex
+  cats?: Cat[]
 
-export class CatColors extends Model {
   static get tableName() {
-    return 'cat_colors'
+    return 'catColor'
   }
 
   static get idColumn() {
@@ -24,23 +31,23 @@ export class CatColors extends Model {
 
   static get relationMappings() {
     const { ColorHex } = require('./ColorHex')
-    const { Cats } = require('./Cats')
+    const { Cat } = require('./Cat')
 
     return {
       cats: {
         relation: Model.HasManyRelation,
-        modelClass: Cats,
+        modelClass: Cat,
         join: {
-          from: 'cat_colors.id',
-          to: 'cats.cat_color_id',
+          from: 'catColor.id',
+          to: 'cat.catColorId',
         },
       },
       colorHex: {
         relation: Model.HasOneRelation,
         modelClass: ColorHex,
         join: {
-          from: 'cat_colors.id',
-          to: 'color_hex.id',
+          from: 'catColor.id',
+          to: 'colorHex.id',
         },
       },
     }

src/Packages/objection/src/Databases/CatDatabase/ColorHex.ts

@@ -2,8 +2,11 @@
 import { Model } from 'objection'
 
 export class ColorHex extends Model {
+  id!: number
+  hexCode!: string
+
   static get tableName() {
-    return 'color_hex'
+    return 'colorHex'
   }
 
   static get idColumn() {
@@ -30,8 +33,8 @@ export class ColorHex extends Model {
         relation: Model.HasOneRelation,
         modelClass: CatColor,
         join: {
-          from: 'color_hex.id',
-          to: 'cat_colors.id',
+          from: 'colorHex.id',
+          to: 'catColor.id',
         },
       },
     }

src/Packages/objection/src/Databases/CatDatabase/House.ts

@@ -2,8 +2,12 @@
 import { Model } from 'objection'
 
 export class House extends Model {
+  id: number
+  houseAddress: string
+  hasDog: boolean
+
   static get tableName() {
-    return 'houses'
+    return 'house'
   }
 
   static get idColumn() {
@@ -23,28 +27,28 @@ export class House extends Model {
   }
 
   static get relationMappings() {
-    const { CatsModel } = require('./Cats')
-    const { ToysHouse } = require('./ToysHouse')
+    const { Cat } = require('./Cat')
+    const { ToyHouse } = require('./ToyHouse')
 
     return {
       cats: {
         relation: Model.ManyToManyRelation,
-        modelClass: CatsModel,
+        modelClass: Cat,
         join: {
-          from: 'houses.id',
+          from: 'house.id',
           through: {
-            from: 'houseCats.houseId',
-            to: 'houseCats.catId',
+            from: 'houseCat.houseId',
+            to: 'houseCat.catId',
           },
-          to: 'cats.id',
+          to: 'cat.id',
         },
       },
       toysHouse: {
         relation: Model.HasManyRelation,
-        modelClass: ToysHouse,
+        modelClass: ToyHouse,
         join: {
-          from: 'houses.id',
-          to: 'toysHouse.house_id',
+          from: 'house.id',
+          to: 'toyHouse.houseId',
         },
       },
     }

src/Packages/objection/src/Databases/CatDatabase/Toys.ts renamed to src/Packages/objection/src/Databases/CatDatabase/Toy.ts

@@ -1,9 +1,21 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { Model } from 'objection'
+import { ToysProducer } from './ToysProducer'
+import { House } from './House'
+
+export class Toy extends Model {
+  id!: number
+  currency!: string
+  toyName!: string
+  price!: number
+  naugthy!: string
+  barcode!: string
+  toysProducerId!: number
+  toysProducer?: ToysProducer
+  houses?: House[]
 
-export class Toys extends Model {
   static get tableName() {
-    return 'toys'
+    return 'toy'
   }
 
   static get idColumn() {
@@ -27,26 +39,39 @@ export class Toys extends Model {
   }
 
   static get relationMappings() {
-    const { ToysHouse } = require('./ToysHouse')
+    const { ToyHouse } = require('./ToyHouse')
     const { ToysProducer } = require('./ToysProducer')
+    const { House } = require('./House')
 
     return {
       toysHouse: {
         relation: Model.HasManyRelation,
-        modelClass: ToysHouse,
+        modelClass: ToyHouse,
         join: {
-          from: 'toys.id',
-          to: 'toysHouse.toys_id',
+          from: 'toy.id',
+          to: 'toyHouse.toyId',
         },
       },
       toysProducer: {
         relation: Model.BelongsToOneRelation,
         modelClass: ToysProducer,
         join: {
-          from: 'toys.producer_id',
+          from: 'toy.producerId',
           to: 'toysProducer.id',
         },
       },
+      houses: {
+        relation: Model.ManyToManyRelation,
+        modelClass: House,
+        join: {
+          from: 'toy.id',
+          through: {
+            from: 'toyHouse.toyId',
+            to: 'toyHouse.houseId',
+          },
+          to: 'house.id',
+        },
+      },
     }
   }
 }

src/Packages/objection/src/Databases/CatDatabase/ToysHouse.ts renamed to src/Packages/objection/src/Databases/CatDatabase/ToyHouse.ts

@@ -1,13 +1,17 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
 import { Model } from 'objection'
 
-export class ToysHouse extends Model {
+export class ToyHouse extends Model {
+  toyId: number
+  houseId: number
+  amount: number
+
   static get tableName() {
-    return 'toysHouse'
+    return 'toyHouse'
   }
 
   static get idColumn() {
-    return ['toys_id', 'house_id']
+    return ['toy_id', 'house_id']
   }
 
   static get jsonSchema() {
@@ -16,31 +20,31 @@ export class ToysHouse extends Model {
       required: ['name'],
 
       properties: {
-        toys_id: { type: 'integer' },
-        house_id: { type: 'integer' },
+        toyId: { type: 'integer' },
+        houseId: { type: 'integer' },
         amount: { type: 'integer' },
       },
     }
   }
 
   static get relationMappings() {
-    const { Toys } = require('./Toys')
+    const { Toy } = require('./Toy')
     const { House } = require('./House')
 
     return {
       toys: {
         relation: Model.BelongsToOneRelation,
-        modelClass: Toys,
+        modelClass: Toy,
         join: {
-          from: 'toysHouse.toys_id',
-          to: 'toys.id',
+          from: 'toyHouse.toyId',
+          to: 'toy.id',
         },
       },
       house: {
         relation: Model.BelongsToOneRelation,
         modelClass: House,
         join: {
-          from: 'toysHouse.house_id',
+          from: 'toyHouse.houseId',
           to: 'house.id',
         },
       },

src/Packages/objection/src/Databases/CatDatabase/ToysProducer.ts

@@ -2,6 +2,10 @@
 import { Model } from 'objection'
 
 export class ToysProducer extends Model {
+  id: number
+  stockInfo: Record<string, any>
+  hqLocation: Record<string, any>
+
   static get tableName() {
     return 'toysProducer'
   }
@@ -31,7 +35,7 @@ export class ToysProducer extends Model {
         modelClass: Toys,
         join: {
           from: 'toysProducer.id',
-          to: 'toys.producer_id',
+          to: 'toy.producerId',
         },
       },
     }

src/Packages/objection/src/index.ts

@@ -1,4 +1,4 @@
-import { Model } from 'objection'
+import { Model, knexSnakeCaseMappers } from 'objection'
 import knex from 'knex'
 import IORMPackage from 'BenchmarkUtils/interfaces/PackageUtils'
 import EntityTraversal from './Benchmarks/EntityTraversal'
@@ -12,6 +12,7 @@ const initialize = async () => {
       password: 'benchmark_pwd',
       database: 'benchmark',
     },
+    ...knexSnakeCaseMappers(),
   })
 
   Model.knex(_knex)