tspace-mysql 1.9.0-beta.1 → 1.9.0-beta.2

package/README.md

@@ -10,7 +10,7 @@ tspace-mysql is an Object-Relational Mapping (ORM) tool designed to run seamless
 
 | **Feature**                    | **Description**                                                                                         |
 |--------------------------------|---------------------------------------------------------------------------------------------------------|
-| **Supports Driver**            | MySQL ✅ / MariaDB ✅ / Postgres / ✅ MSSQL ⏳ / SQLite3 ⏳ / Oracle ⏳                                |
+| **Supports Driver**            | MySQL ✅ / MariaDB ✅ / Postgres ✅ / SQLite ✅ / Mongodb ✅ (yes, even MongoDB 😏) /  MSSQL ⏳      |
 | **Query Builder**              | Create flexible queries like `SELECT`, `INSERT`, `UPDATE`, and `DELETE`. You can also use raw SQL.      |
 | **Join Clauses**               | Use `INNER JOIN`, `LEFT JOIN`, `RIGHT JOIN`, and `CROSS JOIN` to combine data from multiple tables.     |
 | **Model**                      | Provides a way to interact with database records as objects in code. You can perform create, read, update, and delete (CRUD) operations. Models also support soft deletes and relationship methods. |
@@ -24,6 +24,7 @@ tspace-mysql is an Object-Relational Mapping (ORM) tool designed to run seamless
 | **Repository**                 | Follows a pattern for managing database operations like `SELECT`, `INSERT`, `UPDATE`, and `DELETE`. It helps keep the code organized. |
 | **Decorators**                 | Use decorators to add extra functionality or information to model classes and methods, making the code easier to read. |
 | **Caching**                    | Improves performance by storing frequently requested data. Supports in-memory caching (like memory DB) and Redis for distributed caching. |
+| **Queue**                      | Job queue for background and async processing. Runs on top of databases for distributed workers (similar to pg-boss). |
 | **Migrations**                 | Use CLI commands to create models, make migrations, and apply changes to the database structure.          |
 | **Blueprints**                 | Create a clear layout of the database structure and how models and tables relate to each other.          |
 | **CLI**                        | A Command Line Interface for managing models, running migrations, executing queries, and performing other tasks using commands (like `make:model`, `migrate`, and `query`). |
@@ -163,6 +164,7 @@ npm install -D typescript@5.9.3
   - [Repository Delete Statements](#repository-delete-statements)
   - [Repository Transactions](#repository-transactions)
   - [Repository Relations](#repository-relations)
+- [Queue](#queue)
 - [View](#view)
 - [Stored Procedure](#stored-procedure)
 - [Blueprint](#blueprint)
@@ -3841,6 +3843,76 @@ const phoneBelongUser = await phoneRepository.findOne({
 
 ```
 
+## Queue
+A lightweight, high-performance job queue built for ORM-based systems, 
+designed to run on top of database layers with support for concurrency, 
+retries, priorities, and job inspection.
+
+- Concurrency Each worker can process multiple jobs at the same time.
+
+- Priority Higher priority jobs are executed first.
+
+- Retry Failed jobs are automatically retried up to maxAttempts.
+
+- Delay Jobs can be scheduled for future execution using delayMs.
+
+- Idle / Wake Workers automatically go idle when no jobs are available, and wake up instantly when new jobs arrive.
+
+```js
+import { Queue, Job } from 'tspace-mysql';
+
+const fakeSendEmail = async (job: Job) => {
+  if(Math.random() < 0.5) throw new Error(`Failed job ${job.id}`)
+  await new Promise<void>((ok) => setTimeout(ok, 2000));
+  return `Send email Completed job ${job.id}`;
+}
+
+// start the Queue
+await Queue.start({ 
+  inspect : true, 
+  flush : false, // flush = true -> remove all jobs
+  hostname: 'pod1'
+}); 
+
+const worker = 20;
+
+// register process send email 20
+for(let i = 1; i <= worker; i++) {
+
+  Queue.process(`send-email-(${i})`, async(job) => {
+    return await fakeSendEmail(job)
+  } , { concurrency : 10 }) // 1 process / 10 concurrency
+
+}
+
+// add jobs 10_000 records
+for(let j = 1; j <= worker * 500; j++) {
+
+    const i = Math.floor((Math.random() * worker) + 1);
+
+    Queue.add(`send-email-(${i})`, {
+        email: `John-${i}@gmail.com`,
+        name: `John-${i}`
+    }, {
+        delayMs : 1000 * Math.random() * 10,
+        priority : i % 2 ? 9999 + Math.floor((Math.random() * 9999) + 1) : 0,
+        maxAttempts : 3,
+        metadata : {
+            userId : j,
+            name   : `John-${i}`
+        }
+    })
+}
+
+// for view stats Jobs
+// await Queue.getJobOverallStats()
+// await Queue.getJobStats()
+
+// if you want to end the Queue
+// await Queue.end()
+
+```
+
 ## View
 
 Your database schema can also use views. These views are represented by classes that behave similarly to models, 

package/dist/lib/config/index.d.ts

@@ -13,11 +13,11 @@ declare const Config: Readonly<{
     readonly USERNAME: string | undefined;
     readonly PASSWORD: string;
     readonly DATABASE: string | undefined;
-    readonly CONNECTION_LIMIT: string | 20;
+    readonly CONNECTION_LIMIT: string | 10;
     readonly DATE_STRINGS: string | false;
     readonly CLUSTER: string | false;
     readonly DRIVER: string;
-    readonly CACHE: string;
+    readonly CACHE: "memory" | "db" | "redis";
     readonly CONNECTION_ERROR: string | false;
     readonly CONNECTION_SUCCESS: string | false;
 }>;

package/dist/lib/config/index.js

@@ -4,16 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Config = exports.loadOptionsEnv = void 0;
-const tool_1 = require("../tool");
+const Package_1 = require("../core/Package");
 const dotenv_1 = __importDefault(require("dotenv"));
 const resolveEnvPath = (customEnv) => {
     const NODE_ENV = customEnv ?? process.env?.NODE_ENV;
-    const env = tool_1.Tool.path.join(tool_1.Tool.path.resolve(), ".env");
+    const env = Package_1.Package.path.join(Package_1.Package.path.resolve(), ".env");
     if (NODE_ENV == null) {
         return env;
     }
-    const envWithNodeEnv = tool_1.Tool.path.join(tool_1.Tool.path.resolve(), `.env.${NODE_ENV}`);
-    if (tool_1.Tool.fs.existsSync(envWithNodeEnv)) {
+    const envWithNodeEnv = Package_1.Package.path.join(Package_1.Package.path.resolve(), `.env.${NODE_ENV}`);
+    if (Package_1.Package.fs.existsSync(envWithNodeEnv)) {
         return envWithNodeEnv;
     }
     return env;
@@ -21,17 +21,19 @@ const resolveEnvPath = (customEnv) => {
 dotenv_1.default.config({ path: resolveEnvPath() });
 const ENV = process.env;
 const rawEnv = {
+    // general
     HOST: ENV.DB_HOST ?? "localhost",
     PORT: ENV.DB_PORT ?? 3306,
     USERNAME: ENV.DB_USERNAME ?? ENV.DB_USER,
     PASSWORD: ENV.DB_PASSWORD ?? "",
     DATABASE: ENV.DB_DATABASE,
-    CONNECTION_LIMIT: ENV.DB_CONNECTION_LIMIT ?? 20,
+    CONNECTION_LIMIT: ENV.DB_CONNECTION_LIMIT ?? 10,
     // for mysql2 only
     DATE_STRINGS: ENV.DB_DATE_STRINGS ?? false,
+    // options
     CLUSTER: ENV.DB_CLUSTER ?? false,
     DRIVER: ENV.DB_DRIVER ?? "mysql2",
-    CACHE: ENV.DB_CACHE ?? "memory",
+    CACHE: ENV.DB_CACHE,
     CONNECTION_ERROR: ENV.DB_CONNECTION_ERROR ?? false,
     CONNECTION_SUCCESS: ENV.DB_CONNECTION_SUCCESS ?? false,
 };

package/dist/lib/config/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/config/index.ts"],"names":[],"mappings":";;;;;;AAAA,kCAA+B;AAC/B,oDAA4B;AAE5B,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAU,EAAE;IACpD,MAAM,QAAQ,GAAG,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC;IACpD,MAAM,GAAG,GAAG,WAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IAExD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,cAAc,GAAG,WAAI,CAAC,IAAI,CAAC,IAAI,CACnC,WAAI,CAAC,IAAI,CAAC,OAAO,EAAE,EACnB,QAAQ,QAAQ,EAAE,CACnB,CAAC;IAEF,IAAI,WAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QACvC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;AAE1C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AAExB,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,WAAW;IAChC,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,IAAI;IACzB,QAAQ,EAAE,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,OAAO;IACxC,QAAQ,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE;IAC/B,QAAQ,EAAE,GAAG,CAAC,WAAW;IACzB,gBAAgB,EAAE,GAAG,CAAC,mBAAmB,IAAI,EAAE;IAE/C,kBAAkB;IAClB,YAAY,EAAE,GAAG,CAAC,eAAe,IAAI,KAAK;IAE1C,OAAO,EAAE,GAAG,CAAC,UAAU,IAAI,KAAK;IAChC,MAAM,EAAE,GAAG,CAAC,SAAS,IAAI,QAAQ;IACjC,KAAK,EAAE,GAAG,CAAC,QAAQ,IAAK,QAAsC;IAC9D,gBAAgB,EAAE,GAAG,CAAC,mBAAmB,IAAI,KAAK;IAClD,kBAAkB,EAAE,GAAG,CAAC,qBAAqB,IAAI,KAAK;CAC9C,CAAC;AAEX,MAAM,QAAQ,GAAG,CAAmB,GAAM,EAAK,EAAE;IAC/C,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,IAAI,IAAI;YAAE,SAAS;QAE5B,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,SAAS;QACX,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC5B,SAAS;YACX,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,SAAS;QACX,CAAC;QAED,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,EACnE,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;YAE7C,SAAS;QACX,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,OAAO,MAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,QAAQ,CAAgB,MAAM,CAAC,CAAC;AAErC,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAE,EAAE;IACnD,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAE1C,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,MAAM,MAAM,GAAG;QACb,OAAO,EAAE,GAAG,CAAC,UAAU,IAAI,KAAK;QAChC,MAAM,EAAE,GAAG,CAAC,SAAS,IAAI,QAAQ;QACjC,IAAI,EAAE,GAAG,CAAC,OAAO;QACjB,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,IAAI;QACzB,QAAQ,EAAE,GAAG,CAAC,WAAW;QACzB,QAAQ,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE;QAC/B,QAAQ,EAAE,GAAG,CAAC,WAAW;KACjB,CAAC;IAEX,MAAM,GAAG,GAAG,QAAQ,CAAgB,MAAM,CAAC,CAAC;IAE5C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAkB,CAAC;AAC7C,CAAC,CAAC;AApBW,QAAA,cAAc,kBAoBzB;AAEF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAEzB,wBAAM;AACf,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/config/index.ts"],"names":[],"mappings":";;;;;;AAAA,6CAA0C;AAC1C,oDAA4B;AAE5B,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAU,EAAE;IACpD,MAAM,QAAQ,GAAG,SAAS,IAAI,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC;IACpD,MAAM,GAAG,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC;IAE9D,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,cAAc,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,CACtC,iBAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EACtB,QAAQ,QAAQ,EAAE,CACnB,CAAC;IAEF,IAAI,iBAAO,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAC1C,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;AAE1C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;AAExB,MAAM,MAAM,GAAG;IACb,UAAU;IACV,IAAI,EAAe,GAAG,CAAC,OAAO,IAAI,WAAW;IAC7C,IAAI,EAAe,GAAG,CAAC,OAAO,IAAI,IAAI;IACtC,QAAQ,EAAW,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,OAAO;IACjD,QAAQ,EAAW,GAAG,CAAC,WAAW,IAAI,EAAE;IACxC,QAAQ,EAAW,GAAG,CAAC,WAAW;IAClC,gBAAgB,EAAG,GAAG,CAAC,mBAAmB,IAAI,EAAE;IAEhD,kBAAkB;IAClB,YAAY,EAAE,GAAG,CAAC,eAAe,IAAI,KAAK;IAE1C,UAAU;IACV,OAAO,EAAE,GAAG,CAAC,UAAU,IAAI,KAAK;IAChC,MAAM,EAAE,GAAG,CAAC,SAAS,IAAI,QAAQ;IACjC,KAAK,EAAE,GAAG,CAAC,QAAqC;IAChD,gBAAgB,EAAE,GAAG,CAAC,mBAAmB,IAAI,KAAK;IAClD,kBAAkB,EAAE,GAAG,CAAC,qBAAqB,IAAI,KAAK;CAC9C,CAAC;AAEX,MAAM,QAAQ,GAAG,CAAmB,GAAM,EAAK,EAAE;IAC/C,MAAM,MAAM,GAA4B,EAAE,CAAC;IAE3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,KAAK,IAAI,IAAI;YAAE,SAAS;QAE5B,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,SAAS;QACX,CAAC;QAED,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACxC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC5B,SAAS;YACX,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YACpB,SAAS;QACX,CAAC;QAED,IACE,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,EACnE,CAAC;YACD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;YAE7C,SAAS;QACX,CAAC;QAED,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,OAAO,MAAW,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,GAAG,GAAG,QAAQ,CAAgB,MAAM,CAAC,CAAC;AAErC,MAAM,cAAc,GAAG,CAAC,SAAkB,EAAE,EAAE;IACnD,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;IAE1C,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IAEjD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,MAAM,MAAM,GAAG;QACb,OAAO,EAAE,GAAG,CAAC,UAAU,IAAI,KAAK;QAChC,MAAM,EAAE,GAAG,CAAC,SAAS,IAAI,QAAQ;QACjC,IAAI,EAAE,GAAG,CAAC,OAAO;QACjB,IAAI,EAAE,GAAG,CAAC,OAAO,IAAI,IAAI;QACzB,QAAQ,EAAE,GAAG,CAAC,WAAW;QACzB,QAAQ,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE;QAC/B,QAAQ,EAAE,GAAG,CAAC,WAAW;KACjB,CAAC;IAEX,MAAM,GAAG,GAAG,QAAQ,CAAgB,MAAM,CAAC,CAAC;IAE5C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAkB,CAAC;AAC7C,CAAC,CAAC;AApBW,QAAA,cAAc,kBAoBzB;AAEF,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAEzB,wBAAM;AACf,kBAAe,MAAM,CAAC"}

package/dist/lib/constants/index.d.ts

@@ -105,6 +105,8 @@ declare const CONSTANTS: Readonly<{
     NULLIF: "NULLIF";
     INFORMATION_SCHEMA: "INFORMATION_SCHEMA";
     STATISTICS: "STATISTICS";
+    TYPE: "TYPE";
+    COLUMN: "COLUMN";
     RELATIONSHIP: {
         hasOne: string;
         hasMany: string;
@@ -120,6 +122,8 @@ declare const CONSTANTS: Readonly<{
     ROW_LEVEL_LOCK: {
         update: string;
         share: string;
+        skipLocked: string;
+        nowait: string;
     };
 }>;
 export { CONSTANTS };

package/dist/lib/constants/index.js

@@ -108,6 +108,8 @@ const CONSTANTS = Object.freeze({
     NULLIF: 'NULLIF',
     INFORMATION_SCHEMA: 'INFORMATION_SCHEMA',
     STATISTICS: 'STATISTICS',
+    TYPE: 'TYPE',
+    COLUMN: 'COLUMN',
     RELATIONSHIP: {
         hasOne: 'hasOne',
         hasMany: 'hasMany',
@@ -122,7 +124,9 @@ const CONSTANTS = Object.freeze({
     },
     ROW_LEVEL_LOCK: {
         update: 'FOR UPDATE',
-        share: 'LOCK IN SHARE MODE'
+        share: 'LOCK IN SHARE MODE',
+        skipLocked: 'SKIP LOCKED',
+        nowait: 'NOWAIT'
     }
 });
 exports.CONSTANTS = CONSTANTS;

package/dist/lib/constants/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/constants/index.ts"],"names":[],"mappings":";;;AAAA,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5B,IAAI,EAAG,MAAM;IACb,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAG,QAAQ;IACjB,OAAO,EAAG,SAAS;IACnB,MAAM,EAAG,QAAQ;IACjB,KAAK,EAAG,OAAO;IACf,OAAO,EAAG,SAAS;IACnB,WAAW,EAAG,aAAa;IAC3B,GAAG,EAAG,KAAK;IACX,IAAI,EAAG,MAAM;IACb,OAAO,EAAE,SAAS;IAClB,WAAW,EAAC,aAAa;IACzB,EAAE,EAAG,IAAI;IACT,IAAI,EAAG,MAAM;IACb,MAAM,EAAG,QAAQ;IACjB,QAAQ,EAAG,UAAU;IACrB,IAAI,EAAG,MAAM;IACb,MAAM,EAAG,QAAQ;IACjB,QAAQ,EAAG,UAAU;IACrB,YAAY,EAAC,cAAc;IAC3B,QAAQ,EAAG,UAAU;IACrB,IAAI,EAAG,MAAM;IACb,GAAG,EAAG,KAAK;IACX,UAAU,EAAG,YAAY;IACzB,SAAS,EAAG,WAAW;IACvB,UAAU,EAAG,YAAY;IACzB,UAAU,EAAG,YAAY;IACzB,EAAE,EAAG,IAAI;IACT,KAAK,EAAG,OAAO;IACf,MAAM,EAAG,QAAQ;IACjB,KAAK,EAAG,OAAO;IACf,GAAG,EAAG,KAAK;IACX,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,EAAE,EAAG,IAAI;IACT,EAAE,EAAG,GAAG;IACR,MAAM,EAAG,IAAI;IACb,EAAE,EAAG,IAAI;IACT,MAAM,EAAG,QAAQ;IACjB,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,GAAG,EAAG,KAAK;IACX,GAAG,EAAG,KAAK;IACX,SAAS,EAAG,WAAW;IACvB,GAAG,EAAE,KAAK;IACV,GAAG,EAAG,OAAO;IACb,EAAE,EAAG,MAAM;IACX,MAAM,EAAG,UAAU;IACnB,KAAK,EAAG,SAAS;IACjB,MAAM,EAAG,SAAS;IAClB,IAAI,EAAG,MAAM;IACb,IAAI,EAAG,MAAM;IACb,IAAI,EAAG,MAAM;IACb,IAAI,EAAG,MAAM;IACb,GAAG,EAAG,KAAK;IACX,gBAAgB,EAAG,kBAAkB;IACrC,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAG,QAAQ;IACjB,MAAM,EAAG,QAAQ;IACjB,MAAM,EAAG,QAAQ;IACjB,MAAM,EAAG,aAAa;IACtB,IAAI,EAAG,MAAM;IACb,aAAa,EAAG,eAAe;IAC/B,UAAU,EAAG,YAAY;IACzB,SAAS,EAAE,qBAAqB;IAChC,cAAc,EAAG,gBAAgB;IACjC,eAAe,EAAG,iBAAiB;IACnC,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAI,gBAAgB;IAClC,WAAW,EAAG,aAAa;IAC3B,0BAA0B,EAAG,+BAA+B;IAC5D,YAAY,EAAG,cAAc;IAC7B,uBAAuB,EAAG,4BAA4B;IACtD,YAAY,EAAG,cAAc;IAC7B,SAAS,EAAM,WAAW;IAC1B,MAAM,EAAC,wDAAwD;IAC/D,OAAO,EAAE,SAAS;IAClB,IAAI,EAAG,QAAQ;IACf,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAG,aAAa;IAC3B,WAAW,EAAG,aAAa;IAC3B,UAAU,EAAG,YAAY;IACzB,SAAS,EAAG,WAAW;IACvB,SAAS,EAAG,WAAW;IACvB,GAAG,EAAG,KAAK;IACX,MAAM,EAAG,QAAQ;IACjB,UAAU,EAAG,YAAY;IACzB,cAAc,EAAG,gBAAgB;IACjC,KAAK,EAAG,OAAO;IACf,WAAW,EAAG,aAAa;IAC3B,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAG,OAAO;IACf,MAAM,EAAG,QAAQ;IACjB,UAAU,EAAG,YAAY;IACzB,aAAa,EAAG,eAAe;IAC/B,WAAW,EAAG,aAAa;IAC3B,KAAK,EAAG,OAAO;IACf,SAAS,EAAG,WAAW;IACvB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,kBAAkB,EAAE,oBAAoB;IACxC,UAAU,EAAE,YAAY;IACxB,YAAY,EAAG;QACX,MAAM,EAAG,QAAQ;QACjB,OAAO,EAAG,SAAS;QACnB,SAAS,EAAG,WAAW;QACvB,aAAa,EAAG,eAAe;QAC/B,mBAAmB,EAAG,qBAAqB;KAC9C;IACD,OAAO,EAAG;QACN,OAAO,EAAG,SAAS;QACnB,UAAU,EAAG,YAAY;QACzB,SAAS,EAAG,WAAW;KAC1B;IACD,cAAc,EAAG;QACb,MAAM,EAAG,YAAY;QACrB,KAAK,EAAI,oBAAoB;KAChC;CACJ,CAAC,CAAA;AAEO,8BAAS;AAClB,kBAAe,SAAS,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/constants/index.ts"],"names":[],"mappings":";;;AAAA,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;IAC5B,IAAI,EAAG,MAAM;IACb,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAG,QAAQ;IACjB,OAAO,EAAG,SAAS;IACnB,MAAM,EAAG,QAAQ;IACjB,KAAK,EAAG,OAAO;IACf,OAAO,EAAG,SAAS;IACnB,WAAW,EAAG,aAAa;IAC3B,GAAG,EAAG,KAAK;IACX,IAAI,EAAG,MAAM;IACb,OAAO,EAAE,SAAS;IAClB,WAAW,EAAC,aAAa;IACzB,EAAE,EAAG,IAAI;IACT,IAAI,EAAG,MAAM;IACb,MAAM,EAAG,QAAQ;IACjB,QAAQ,EAAG,UAAU;IACrB,IAAI,EAAG,MAAM;IACb,MAAM,EAAG,QAAQ;IACjB,QAAQ,EAAG,UAAU;IACrB,YAAY,EAAC,cAAc;IAC3B,QAAQ,EAAG,UAAU;IACrB,IAAI,EAAG,MAAM;IACb,GAAG,EAAG,KAAK;IACX,UAAU,EAAG,YAAY;IACzB,SAAS,EAAG,WAAW;IACvB,UAAU,EAAG,YAAY;IACzB,UAAU,EAAG,YAAY;IACzB,EAAE,EAAG,IAAI;IACT,KAAK,EAAG,OAAO;IACf,MAAM,EAAG,QAAQ;IACjB,KAAK,EAAG,OAAO;IACf,GAAG,EAAG,KAAK;IACX,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,EAAE,EAAG,IAAI;IACT,EAAE,EAAG,GAAG;IACR,MAAM,EAAG,IAAI;IACb,EAAE,EAAG,IAAI;IACT,MAAM,EAAG,QAAQ;IACjB,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,GAAG,EAAG,KAAK;IACX,GAAG,EAAG,KAAK;IACX,SAAS,EAAG,WAAW;IACvB,GAAG,EAAE,KAAK;IACV,GAAG,EAAG,OAAO;IACb,EAAE,EAAG,MAAM;IACX,MAAM,EAAG,UAAU;IACnB,KAAK,EAAG,SAAS;IACjB,MAAM,EAAG,SAAS;IAClB,IAAI,EAAG,MAAM;IACb,IAAI,EAAG,MAAM;IACb,IAAI,EAAG,MAAM;IACb,IAAI,EAAG,MAAM;IACb,GAAG,EAAG,KAAK;IACX,gBAAgB,EAAG,kBAAkB;IACrC,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAG,QAAQ;IACjB,MAAM,EAAG,QAAQ;IACjB,MAAM,EAAG,QAAQ;IACjB,MAAM,EAAG,aAAa;IACtB,IAAI,EAAG,MAAM;IACb,aAAa,EAAG,eAAe;IAC/B,UAAU,EAAG,YAAY;IACzB,SAAS,EAAE,qBAAqB;IAChC,cAAc,EAAG,gBAAgB;IACjC,eAAe,EAAG,iBAAiB;IACnC,WAAW,EAAE,aAAa;IAC1B,cAAc,EAAI,gBAAgB;IAClC,WAAW,EAAG,aAAa;IAC3B,0BAA0B,EAAG,+BAA+B;IAC5D,YAAY,EAAG,cAAc;IAC7B,uBAAuB,EAAG,4BAA4B;IACtD,YAAY,EAAG,cAAc;IAC7B,SAAS,EAAM,WAAW;IAC1B,MAAM,EAAC,wDAAwD;IAC/D,OAAO,EAAE,SAAS;IAClB,IAAI,EAAG,QAAQ;IACf,cAAc,EAAE,gBAAgB;IAChC,WAAW,EAAG,aAAa;IAC3B,WAAW,EAAG,aAAa;IAC3B,UAAU,EAAG,YAAY;IACzB,SAAS,EAAG,WAAW;IACvB,SAAS,EAAG,WAAW;IACvB,GAAG,EAAG,KAAK;IACX,MAAM,EAAG,QAAQ;IACjB,UAAU,EAAG,YAAY;IACzB,cAAc,EAAG,gBAAgB;IACjC,KAAK,EAAG,OAAO;IACf,WAAW,EAAG,aAAa;IAC3B,YAAY,EAAE,cAAc;IAC5B,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAG,OAAO;IACf,MAAM,EAAG,QAAQ;IACjB,UAAU,EAAG,YAAY;IACzB,aAAa,EAAG,eAAe;IAC/B,WAAW,EAAG,aAAa;IAC3B,KAAK,EAAG,OAAO;IACf,SAAS,EAAG,WAAW;IACvB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,kBAAkB,EAAE,oBAAoB;IACxC,UAAU,EAAE,YAAY;IACxB,IAAI,EAAG,MAAM;IACb,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAG;QACX,MAAM,EAAG,QAAQ;QACjB,OAAO,EAAG,SAAS;QACnB,SAAS,EAAG,WAAW;QACvB,aAAa,EAAG,eAAe;QAC/B,mBAAmB,EAAG,qBAAqB;KAC9C;IACD,OAAO,EAAG;QACN,OAAO,EAAG,SAAS;QACnB,UAAU,EAAG,YAAY;QACzB,SAAS,EAAG,WAAW;KAC1B;IACD,cAAc,EAAG;QACb,MAAM,EAAG,YAAY;QACrB,KAAK,EAAI,oBAAoB;QAC7B,UAAU,EAAE,aAAa;QACzB,MAAM,EAAG,QAAQ;KACpB;CACJ,CAAC,CAAA;AAEO,8BAAS;AAClB,kBAAe,SAAS,CAAA"}

package/dist/lib/core/Abstracts/AbstractBuilder.d.ts

@@ -24,6 +24,7 @@ declare abstract class AbstractBuilder {
         set: Function;
         get: Function;
         queryBuilder: Function;
+        transaction: Function;
     };
     abstract void(): this;
     abstract debug(): this;
@@ -51,8 +52,8 @@ declare abstract class AbstractBuilder {
     abstract whereSubQuery(column: string, subQuery: string): this;
     abstract whereNotSubQuery(column: string, subQuery: string): this;
     abstract orWhereSubQuery(column: string, subQuery: string): this;
-    abstract whereBetween(column: string, arrayValue: any[]): this;
-    abstract whereNotBetween(column: string, arrayValue: any[]): this;
+    abstract whereBetween(column: string, arrayValue: [any, any]): this;
+    abstract whereNotBetween(column: string, arrayValue: [any, any]): this;
     abstract having(condition: string): this;
     abstract join(pk: string | ((join: Join) => Join), fk?: string): this;
     abstract rightJoin(pk: string | ((join: Join) => Join), fk?: string): this;

package/dist/lib/core/Abstracts/AbstractBuilder.js

@@ -20,7 +20,8 @@ class AbstractBuilder {
         query: (sql) => { },
         set: (pool) => { },
         get: () => { },
-        queryBuilder: () => { }
+        queryBuilder: () => { },
+        transaction: () => { },
     };
 }
 exports.AbstractBuilder = AbstractBuilder;

package/dist/lib/core/Abstracts/AbstractBuilder.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractBuilder.js","sourceRoot":"","sources":["../../../../src/lib/core/Abstracts/AbstractBuilder.ts"],"names":[],"mappings":";;;AAGA,yCAA4C;AAM5C,MAAe,eAAe;IAEhB,MAAM,CAAU;IAEhB,SAAS,GAAY,MAAM,CAAC,eAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;IAEnD,YAAY,GAAG;QACrB,IAAI,EAAO,eAAM,CAAC,IAAI;QACtB,IAAI,EAAO,MAAM,CAAC,eAAM,CAAC,IAAI,CAAC;QAC9B,QAAQ,EAAG,MAAM,CAAC,eAAM,CAAC,QAAQ,CAAC;QAClC,QAAQ,EAAG,MAAM,CAAC,eAAM,CAAC,QAAQ,CAAC;QAClC,QAAQ,EAAG,eAAM,CAAC,QAAQ;KAC7B,CAAA;IAES,OAAO,GAAI,MAAM,CAAC,eAAM,CAAC,MAAM,IAAI,OAAO,CAAY,CAAC;IAEvD,QAAQ,GAAa,OAAO,CAAC,eAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;IAEtD,UAAU,CAGlB;IAEQ,MAAM,CAAgB;IAEtB,KAAK,GAKX;QACA,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,GAAE,CAAC;QAC1B,GAAG,EAAE,CAAC,IAAU,EAAE,EAAE,GAAE,CAAC;QACvB,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;QACb,YAAY,EAAE,GAAG,EAAE,GAAE,CAAC;KACzB,CAAA;CAyFJ;AAES,0CAAe;AACzB,kBAAe,eAAe,CAAA"}
+{"version":3,"file":"AbstractBuilder.js","sourceRoot":"","sources":["../../../../src/lib/core/Abstracts/AbstractBuilder.ts"],"names":[],"mappings":";;;AAGA,yCAA4C;AAM5C,MAAe,eAAe;IAEhB,MAAM,CAAU;IAEhB,SAAS,GAAY,MAAM,CAAC,eAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;IAEnD,YAAY,GAAG;QACrB,IAAI,EAAO,eAAM,CAAC,IAAI;QACtB,IAAI,EAAO,MAAM,CAAC,eAAM,CAAC,IAAI,CAAC;QAC9B,QAAQ,EAAG,MAAM,CAAC,eAAM,CAAC,QAAQ,CAAC;QAClC,QAAQ,EAAG,MAAM,CAAC,eAAM,CAAC,QAAQ,CAAC;QAClC,QAAQ,EAAG,eAAM,CAAC,QAAQ;KAC7B,CAAA;IAES,OAAO,GAAI,MAAM,CAAC,eAAM,CAAC,MAAM,IAAI,OAAO,CAAY,CAAC;IAEvD,QAAQ,GAAa,OAAO,CAAC,eAAM,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC;IAEtD,UAAU,CAGlB;IAEQ,MAAM,CAAgB;IAEtB,KAAK,GAMX;QACA,KAAK,EAAE,CAAC,GAAW,EAAE,EAAE,GAAE,CAAC;QAC1B,GAAG,EAAE,CAAC,IAAU,EAAE,EAAE,GAAE,CAAC;QACvB,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;QACb,YAAY,EAAE,GAAG,EAAE,GAAE,CAAC;QACtB,WAAW,EAAE,GAAG,EAAE,GAAE,CAAC;KACxB,CAAA;CAyFJ;AAES,0CAAe;AACzB,kBAAe,eAAe,CAAA"}

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

@@ -23,12 +23,61 @@ declare class Builder extends AbstractBuilder {
      */
     database(): string;
     /**
-     * The 'rowLock' method is used to row level locks
+     * The 'rowLock' method is used to row level locks (`FOR UPDATE` or `FOR SHARE`) to the query.
      *
      * @param {string} mode
      * @returns {this} this
      */
-    rowLock(mode: "FOR_UPDATE" | "FOR_SHARE"): this;
+    rowLock(mode: "FOR_UPDATE" | "FOR_SHARE", opts?: {
+        skipLocked?: boolean;
+        nowait?: boolean;
+    }): this;
+    /**
+     * The 'forUpdate' method is used to applies a row-level exclusive lock (`FOR UPDATE`) to the query.
+     *
+     * This lock prevents other transactions from modifying or acquiring
+     * conflicting locks on the selected rows until the current transaction
+     * is committed or rolled back.
+     *
+     * Commonly used in queue systems or critical sections to safely
+     * select and update rows without race conditions.
+     *
+     * @param {Object} [opts] - Locking options
+     * @param {boolean} [opts.skipLocked=false] - If true, skips rows that are already locked by other transactions.
+     *                                           Useful for building non-blocking workers (e.g., job queues).
+     * @param {boolean} [opts.nowait=false] - If true, throws an error immediately if the lock cannot be acquired.
+     *
+     * @throws {Error} If both `skipLocked` and `nowait` are enabled at the same time.
+     *
+     * @returns {this} Returns the query builder instance for chaining.
+     */
+    forUpdate(opts?: {
+        skipLocked?: boolean;
+        nowait?: boolean;
+    }): this;
+    /**
+     * The 'forShare' method is used to applies a row-level exclusive lock (`FOR SHARE`) to the query.
+     *
+     * This lock prevents other transactions from modifying or acquiring
+     * conflicting locks on the selected rows until the current transaction
+     * is committed or rolled back.
+     *
+     * Commonly used in queue systems or critical sections to safely
+     * select and update rows without race conditions.
+     *
+     * @param {Object} [opts] - Locking options
+     * @param {boolean} [opts.skipLocked=false] - If true, skips rows that are already locked by other transactions.
+     *                                           Useful for building non-blocking workers (e.g., job queues).
+     * @param {boolean} [opts.nowait=false] - If true, throws an error immediately if the lock cannot be acquired.
+     *
+     * @throws {Error} If both `skipLocked` and `nowait` are enabled at the same time.
+     *
+     * @returns {this} Returns the query builder instance for chaining.
+     */
+    forShare(opts?: {
+        skipLocked?: boolean;
+        nowait?: boolean;
+    }): this;
     /**
      * The 'unset' method is used to drop a property as desired.
      * @param {object} options
@@ -1162,6 +1211,40 @@ declare class Builder extends AbstractBuilder {
         ParentTable: string;
         ParentColumn: string;
     }[]>;
+    /**
+     * Adds a foreign key constraint to a table.
+     *
+     * This method checks whether the specified foreign key constraint already exists
+     * on the table before attempting to create it. If the constraint exists, an error
+     * will be thrown to prevent duplication.
+     *
+     * @async
+     * @method addFK
+     * @param {Object} params - Parameters for creating the foreign key.
+     * @param {string} params.table - The name of the table where the foreign key will be added.
+     * @param {string} params.tableRef - The referenced table name.
+     * @param {string} params.key - The column in the current table that will act as the foreign key.
+     * @param {string} params.constraint - The name of the foreign key constraint.
+     * @param {Object} params.foreign - Foreign key configuration.
+     * @param {string} params.foreign.references - The referenced column in the referenced table.
+     * @param {string} params.foreign.onDelete - Action when a referenced row is deleted (e.g. CASCADE, SET NULL).
+     * @param {string} params.foreign.onUpdate - Action when a referenced row is updated (e.g. CASCADE, RESTRICT).
+     *
+     * @throws {Error} If the specified foreign key constraint already exists.
+     *
+     * @returns {Promise<void>} Resolves when the foreign key constraint is successfully created.
+     */
+    addFK({ table, tableRef, key, constraint, foreign }: {
+        table: string;
+        tableRef: string;
+        key: string;
+        constraint: string;
+        foreign: {
+            references: string;
+            onDelete: string;
+            onUpdate: string;
+        };
+    }): Promise<void>;
     /**
      * The `dropFK` method is used to remove a foreign key constraint from the database.
      * If a table name is provided, the constraint will be dropped from that table;
@@ -1212,35 +1295,165 @@ declare class Builder extends AbstractBuilder {
         name: string;
         table?: string;
     }): Promise<boolean>;
+    /**
+     * Adds an index to a table.
+     *
+     * This method checks whether the specified index already exists on the table
+     * before attempting to create it. If the index exists, an error will be thrown
+     * to prevent duplication.
+     *
+     * @async
+     * @method addIndex
+     * @param {Object} params - Parameters for creating the index.
+     * @param {string} params.name - The name of the index.
+     * @param {string} [params.table] - The table where the index will be created. Defaults to the current model table.
+     * @param {string[]} params.columns - The columns included in the index.
+     *
+     * @throws {Error} If the specified index already exists.
+     *
+     * @returns {Promise<void>} Resolves when the index has been successfully created.
+     */
     addIndex({ name, table, columns }: {
         name: string;
         table?: string;
         columns: string[];
     }): Promise<void>;
+    /**
+     * Drops an index from a table.
+     *
+     * This method checks whether the specified index exists on the table
+     * before attempting to drop it. If the index does not exist, an error
+     * will be thrown.
+     *
+     * @async
+     * @method dropIndex
+     * @param {Object} params - Parameters for dropping the index.
+     * @param {string} params.name - The name of the index to drop.
+     * @param {string} [params.table] - The table from which the index will be removed. Defaults to the current model table.
+     *
+     * @throws {Error} If the specified index was not found.
+     *
+     * @returns {Promise<void>} Resolves when the index has been successfully dropped.
+     */
     dropIndex({ name, table }: {
         name: string;
         table?: string;
     }): Promise<void>;
+    /**
+     * Checks whether a unique constraint exists on a table.
+     *
+     * This method queries the database metadata to determine if the specified
+     * unique constraint exists on the given table.
+     *
+     * @async
+     * @method hasUnique
+     * @param {Object} params - Parameters for checking the unique constraint.
+     * @param {string} params.name - The name of the unique constraint.
+     * @param {string} [params.table] - The table to check. Defaults to the current model table.
+     *
+     * @returns {Promise<boolean>} Returns `true` if the unique constraint exists, otherwise `false`.
+     */
     hasUnique({ name, table }: {
         name: string;
         table?: string;
     }): Promise<boolean>;
+    /**
+     * Adds a unique constraint to a table.
+     *
+     * This method checks whether the specified unique constraint already exists
+     * on the table before attempting to create it. If the constraint already exists,
+     * an error will be thrown to prevent duplication.
+     *
+     * @async
+     * @method addUnique
+     * @param {Object} params - Parameters for creating the unique constraint.
+     * @param {string} params.name - The name of the unique constraint.
+     * @param {string} [params.table] - The table where the unique constraint will be added. Defaults to the current model table.
+     * @param {string[]} params.columns - The columns that will be included in the unique constraint.
+     *
+     * @throws {Error} If the specified unique constraint already exists.
+     *
+     * @returns {Promise<void>} Resolves when the unique constraint has been successfully created.
+     */
     addUnique({ name, table, columns }: {
         name: string;
         table?: string;
         columns: string[];
     }): Promise<void>;
+    /**
+     * Drops a unique constraint from a table.
+     *
+     * This method checks whether the specified unique constraint exists
+     * on the table before attempting to remove it. If the constraint does
+     * not exist, an error will be thrown.
+     *
+     * @async
+     * @method dropUnique
+     * @param {Object} params - Parameters for dropping the unique constraint.
+     * @param {string} params.name - The name of the unique constraint to drop.
+     * @param {string} [params.table] - The table from which the unique constraint will be removed. Defaults to the current model table.
+     *
+     * @throws {Error} If the specified unique constraint was not found.
+     *
+     * @returns {Promise<void>} Resolves when the unique constraint has been successfully dropped.
+     */
     dropUnique({ name, table }: {
         name: string;
         table?: string;
     }): Promise<void>;
+    /**
+     * Checks whether a primary key constraint exists on a table.
+     *
+     * This method queries the database metadata to determine if the specified
+     * table contains a primary key constraint.
+     *
+     * @async
+     * @method hasPrimaryKey
+     * @param {Object} [params={}] - Parameters for checking the primary key.
+     * @param {string} [params.table] - The table to check. Defaults to the current model table.
+     *
+     * @returns {Promise<boolean>} Returns `true` if the table has a primary key constraint,
+     * otherwise `false`.
+     */
     hasPrimaryKey({ table }?: {
         table?: string;
     }): Promise<boolean>;
+    /**
+     * Adds a primary key constraint to a table.
+     *
+     * This method checks whether the table already has a primary key
+     * before attempting to create one. If a primary key already exists,
+     * an error will be thrown.
+     *
+     * @async
+     * @method addPrimaryKey
+     * @param {Object} params - Parameters for creating the primary key.
+     * @param {string} [params.table] - The table where the primary key will be added. Defaults to the current model table.
+     * @param {string[]} params.columns - The column(s) that will form the primary key.
+     *
+     * @throws {Error} If the table already has a primary key constraint.
+     *
+     * @returns {Promise<void>} Resolves when the primary key has been successfully created.
+     */
     addPrimaryKey({ table, columns }: {
         table?: string;
         columns: string[];
     }): Promise<void>;
+    /**
+     * Drops the primary key constraint from a table.
+     *
+     * This method checks whether the table has a primary key before
+     * attempting to remove it. If no primary key exists, an error will be thrown.
+     *
+     * @async
+     * @method dropPrimaryKey
+     * @param {Object} [params={}] - Parameters for dropping the primary key.
+     * @param {string} [params.table] - The table from which the primary key will be removed. Defaults to the current model table.
+     *
+     * @throws {Error} If the specified primary key constraint was not found.
+     *
+     * @returns {Promise<void>} Resolves when the primary key constraint has been successfully removed.
+     */
     dropPrimaryKey({ table }?: {
         table?: string;
     }): Promise<void>;