feat: chunkSize for IWithPostgresOptions

egomobile · Jan 7, 2024 · a0e3f7d · a0e3f7d
1 parent f2c463e
commit a0e3f7d
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Change Log (@egomobile/orm-pg)
 
+## 0.21.0
+
+- add `chunkSize` to [IWithPostgresOptions interface](https://egomobile.github.io/node-orm-pg/interfaces/IWithPostgresOptions.html)
+
 ## 0.20.0
 
 - update to version `^0.14.0` of [node-orm](https://github.com/egomobile/node-orm)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@egomobile/orm-pg",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "A PostgreSQL data adapter and other utilities for @egomobile/orm module.",
   "main": "lib/index.js",
   "engines": {

diff --git a/src/utils/withPostgres.ts b/src/utils/withPostgres.ts
@@ -57,6 +57,12 @@ export interface IWithPostgresConnection {
  * Options for a 'withPostgres()' function.
  */
 export interface IWithPostgresOptions {
+    /**
+     * Custom chunk size for cursor operations.
+     *
+     * @default `100`
+     */
+    chunkSize?: Nilable<number>;
     /**
      * Run action in transaction or not.
      */
@@ -193,6 +199,7 @@ export function createWithPostgres<TConnections extends WithPostgresConnections
             };
         }
 
+        const adapterChunkSize = options?.chunkSize ?? customChunkSize;
         const shouldUseRunInTransaction = !!options?.withTransaction;
 
         let clientClass: Constructor<any> = pg.Client;
@@ -214,7 +221,7 @@ export function createWithPostgres<TConnections extends WithPostgresConnections
         try {
             const context = await createDataContext({
                 "adapter": new PostgreSQLDataAdapter({
-                    "chunkSize": customChunkSize,
+                    "chunkSize": adapterChunkSize,
                     "client": client as PostgreSQLClientLike,
                     "cursorClass": customCursorClass
                 }) as IDataAdapter,