@platformatic/sql-mapper 1.3.1 → 1.4.0

package/mapper.d.ts

@@ -311,6 +311,27 @@ interface BasePoolOptions {
    * @default 10
    */
   poolSize?: number
+
+  /**
+   * Max milliseconds a client can go unused before it is removed from the pool and destroyed
+   * Default is 30_000ms
+   * @default 30000
+   */
+  idleTimeoutMilliseconds?: number
+
+  /**
+   * Number of milliseconds to wait for a connection from the connection pool before throwing a timeout error
+   * Default is 60_000ms
+   * @default 60000
+   */
+  queueTimeoutMilliseconds?: number
+
+  /**
+   * Number of milliseconds to wait for a lock on a connection/transaction.
+   * Default is 60_000ms
+   * @default 60000
+   */
+  acquireLockTimeoutMilliseconds?: number
 }
 
 export interface CreateConnectionPoolOptions extends BasePoolOptions {

package/mapper.js

@@ -11,11 +11,14 @@ const setupCache = require('./lib/cache')
 
 // Ignore the function as it is only used only for MySQL and PostgreSQL
 /* istanbul ignore next */
-async function buildConnection (log, createConnectionPool, connectionString, poolSize, schema) {
+async function buildConnection (log, createConnectionPool, connectionString, poolSize, schema, idleTimeoutMilliseconds, queueTimeoutMilliseconds, acquireLockTimeoutMilliseconds) {
   const db = await createConnectionPool({
     connectionString,
     bigIntMode: 'string',
     poolSize,
+    idleTimeoutMilliseconds,
+    queueTimeoutMilliseconds,
+    acquireLockTimeoutMilliseconds,
     onQueryStart: (_query, { text, values }) => {
       log.trace({
         query: {
@@ -50,7 +53,7 @@ const defaultAutoTimestampFields = {
   updatedAt: 'updated_at'
 }
 
-async function createConnectionPool ({ log, connectionString, poolSize }) {
+async function createConnectionPool ({ log, connectionString, poolSize, idleTimeoutMilliseconds, queueTimeoutMilliseconds, acquireLockTimeoutMilliseconds }) {
   let db
   let sql
 
@@ -59,12 +62,12 @@ async function createConnectionPool ({ log, connectionString, poolSize }) {
   /* istanbul ignore next */
   if (connectionString.indexOf('postgres') === 0) {
     const createConnectionPoolPg = require('@databases/pg')
-    db = await buildConnection(log, createConnectionPoolPg, connectionString, poolSize)
+    db = await buildConnection(log, createConnectionPoolPg, connectionString, poolSize, null, idleTimeoutMilliseconds, queueTimeoutMilliseconds, acquireLockTimeoutMilliseconds)
     sql = createConnectionPoolPg.sql
     db.isPg = true
   } else if (connectionString.indexOf('mysql') === 0) {
     const createConnectionPoolMysql = require('@databases/mysql')
-    db = await buildConnection(log, createConnectionPoolMysql, connectionString, poolSize)
+    db = await buildConnection(log, createConnectionPoolMysql, connectionString, poolSize, null, idleTimeoutMilliseconds, queueTimeoutMilliseconds, acquireLockTimeoutMilliseconds)
     sql = createConnectionPoolMysql.sql
     const version = (await db.query(sql`SELECT VERSION()`))[0]['VERSION()']
     db.version = version
@@ -98,7 +101,7 @@ async function createConnectionPool ({ log, connectionString, poolSize }) {
   return { db, sql }
 }
 
-async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignore = {}, autoTimestamp = true, hooks = {}, schema, limit = {}, dbschema, cache }) {
+async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignore = {}, autoTimestamp = true, hooks = {}, schema, limit = {}, dbschema, cache, idleTimeoutMilliseconds, queueTimeoutMilliseconds, acquireLockTimeoutMilliseconds }) {
   if (typeof autoTimestamp === 'boolean' && autoTimestamp === true) {
     autoTimestamp = defaultAutoTimestampFields
   }
@@ -108,7 +111,7 @@ async function connect ({ connectionString, log, onDatabaseLoad, poolSize, ignor
   }
 
   let queries
-  const { db, sql } = await createConnectionPool({ log, connectionString, poolSize })
+  const { db, sql } = await createConnectionPool({ log, connectionString, poolSize, queueTimeoutMilliseconds, acquireLockTimeoutMilliseconds, idleTimeoutMilliseconds })
 
   /* istanbul ignore next */
   if (db.isPg) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "A data mapper utility for SQL databases",
   "main": "mapper.js",
   "types": "mapper.d.ts",
@@ -32,7 +32,7 @@
     "camelcase": "^6.3.0",
     "fastify-plugin": "^4.5.1",
     "inflected": "^2.1.0",
-    "@platformatic/utils": "1.3.1"
+    "@platformatic/utils": "1.4.0"
   },
   "tsd": {
     "directory": "test/types"