tspace-mysql 1.9.0-beta.6 → 1.9.1

package/README.md

@@ -1360,6 +1360,10 @@ makeCreateTableStatement()
 Within a database transaction, you can utilize the following:
 
 ```js
+import { DB } from 'tspace-mysql';
+import { User } from '../Models/User';
+import { Post } from '../Models/Post';
+
 const trx = await new DB().beginTransaction();
 
 try {
@@ -1441,6 +1445,52 @@ try {
    */
   await trx.rollback();
 }
+```
+Or you can use transaction method for auto commit and rollback, you can utilize the following:
+
+```js
+import { DB } from 'tspace-mysql';
+import { User } from '../Models/User';
+import { Post } from '../Models/Post';
+
+try {
+  
+  const { user, posts } = await DB.transaction(async (trx) => {
+    
+    const user = await new User()
+    .create({
+      name: `tspace`,
+      email: "tspace@example.com",
+    })
+    .bind(trx) // don't forget this
+    .save();
+
+  const posts = await new Post()
+    .createMultiple([
+      {
+        user_id: user.id,
+        title: `tspace-post1`,
+      },
+      {
+        user_id: user.id,
+        title: `tspace-post2`,
+      },
+      {
+        user_id: user.id,
+        title: `tspace-post3`,
+      },
+    ])
+    .bind(trx) // don't forget this
+    .save();
+
+    return { user, posts };
+
+  });
+} catch (err) {
+  // error here is from transaction method, you don't need to worry about rollback, just catch error and handle it.
+  console.error(err);
+}
+
 ```
 
 ## Race Condition
@@ -2662,12 +2712,16 @@ DB_CACHE = redis://username:password@server:6379
 
 const users = await new User()
 .cache({
-  key : 'users', // key of the cache
-  expires : 1000 * 60 // cache expires in 60 seconds
+  key : 'users1', // key of the cache
+  expires : 1000 * 60, // cache expires in 60 seconds
+  namespace : true // add namespace to the key of the cache like that 'db:users:users1' to avoid conflicts with other keys in cache
 })
 .sleep(5) // assume the query takes longer than 5 seconds...
 .findMany()
 
+// delete cache by key
+User.cache.delete('users1', { namespace : true })
+
 ```
 
 ### Decorator
@@ -3525,6 +3579,10 @@ import { User } from '../Models/User'
 
 // Create repository instance for User entity
 const userRepository = Repository(User)
+
+// Or Use static methods for flexible querying
+// const user = await User.findOne({ ... }) // traditional way without repository
+
 // Fetch a single user with flexible query options
 const user = await userRepository.findOne({
   /**
@@ -3633,6 +3691,8 @@ const user = await userRepository.findOne({
 })
 
 
+// Use static methods for flexible querying
+// const users = await User.findMany({ limit: 3 }) // traditional way without repository
 const users = await userRepository.findMany({
   select : {
     id : true,
@@ -3652,6 +3712,8 @@ const users = await userRepository.findMany({
   }
 })
 
+// Use static methods for flexible querying
+// const userPaginate = await User.pagination() // traditional way without repository
 const userPaginate = await userRepository.pagination({
   select : {
     id : true,
@@ -3677,6 +3739,8 @@ const findFullName = await userRepository.findOne({
 ```
 ### Repository Insert Statements
 ```js
+// Use static methods for flexible querying
+// const created = await User.create({...}) // traditional way without repository
 
 const userRepository = Repository(User)
 
@@ -3730,8 +3794,10 @@ const createdOrSelected = await userRepository.createOrSelect({
 ### Repository Update Statements
 ```js
 
-const userRepository = Repository(User)
+// Use static methods for flexible querying
+// const updated = await User.update({...}) // traditional way without repository
 
+const userRepository = Repository(User)
 const updated = await userRepository.update({
   data : {
     name : "repository-name",
@@ -3746,8 +3812,10 @@ const updated = await userRepository.update({
 ### Repository Delete Statements
 ```js
 
-const userRepository = Repository(User)
+// Use static methods for flexible querying
+// const deleted = await User.delete({...}) // traditional way without repository
 
+const userRepository = Repository(User)
 const deleted = await userRepository.delete({
   where : {
     id : 1
@@ -3806,8 +3874,10 @@ import { Repository , OP } from 'tspace-mysql'
 import { User } from '../Models/User'
 import { Phone } from '../Models/Phone'
 
-const userRepository = Repository(User)
+// Use static methods for flexible querying
+// const userHasPhones = await User.findOne({...}) // traditional way without repository
 
+const userRepository = Repository(User)
 const userHasPhones = await userRepository.findOne({
   select : {
     id : true,

package/dist/lib/core/Builder.d.ts

@@ -1575,10 +1575,10 @@ declare class Builder extends AbstractBuilder {
      * The 'find' method is used to retrieve a single record from a database table by its primary key.
      *
      * This method allows you to quickly fetch a specific record by specifying the primary key value, which is typically an integer id.
-     * @param {number} id
+     * @param {number | string} primaryKey
      * @returns {promise<any>}
      */
-    find(id: number): Promise<Record<string, any> | null>;
+    find(primaryKey: number | string): Promise<Record<string, any> | null>;
     /**
      * The 'pagination' method is used to perform pagination on a set of database query results obtained through the Query Builder.
      *

package/dist/lib/core/Builder.js

@@ -2915,11 +2915,11 @@ class Builder extends AbstractBuilder_1.AbstractBuilder {
      * The 'find' method is used to retrieve a single record from a database table by its primary key.
      *
      * This method allows you to quickly fetch a specific record by specifying the primary key value, which is typically an integer id.
-     * @param {number} id
+     * @param {number | string} primaryKey
      * @returns {promise<any>}
      */
-    async find(id) {
-        this.where("id", id);
+    async find(primaryKey) {
+        this.where("id", primaryKey);
         return await this.first();
     }
     /**