bigal 13.1.1 → 13.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [13.2.0](https://github.com/bigalorm/bigal/compare/v13.1.1...v13.2.0) (2025-05-08)
+
+### Features
+
+- add support for schemas ([#111](https://github.com/bigalorm/bigal/issues/111)) ([96af423](https://github.com/bigalorm/bigal/commit/96af423c5933fbc1e5b1860b7b1bac327a4b0357))
+
 ## [13.1.1](https://github.com/bigalorm/bigal/compare/v13.1.0...v13.1.1) (2025-05-05)
 
 # [13.1.0](https://github.com/bigalorm/bigal/compare/v13.0.11...v13.1.0) (2025-05-01)

package/dist/index.cjs

@@ -296,9 +296,13 @@ class ModelMetadata {
   get versionColumns() {
     return this._versionDateColumns;
   }
+  get qualifiedTableName() {
+    return `${this.schema ? `"${this.schema}".` : ""}"${this.tableName}"`;
+  }
   name;
   type;
   connection;
+  schema;
   tableName;
   readonly;
   columnsByColumnName = {};
@@ -308,12 +312,14 @@ class ModelMetadata {
     //
     type,
     connection,
+    schema,
     tableName,
     readonly = false
   }) {
     this.name = name;
     this.type = type;
     this.connection = connection;
+    this.schema = schema;
     this.tableName = tableName ?? ___default.snakeCase(name);
     this.readonly = readonly;
   }
@@ -352,7 +358,7 @@ function getSelectQueryAndParams({
     model,
     select
   });
-  query += ` FROM "${model.tableName}"`;
+  query += ` FROM ${model.qualifiedTableName}`;
   const { whereStatement, params } = buildWhereStatement({
     repositoriesByModelNameLowered,
     model,
@@ -399,7 +405,7 @@ function getCountQueryAndParams({
   model,
   where
 }) {
-  let query = `SELECT count(*) AS "count" FROM "${model.tableName}"`;
+  let query = `SELECT count(*) AS "count" FROM ${model.qualifiedTableName}`;
   const { whereStatement, params } = buildWhereStatement({
     repositoriesByModelNameLowered,
     model,
@@ -489,7 +495,7 @@ function getInsertQueryAndParams({
   }
   const valueCollections = entitiesToInsert.map(() => []);
   const params = [];
-  let query = `INSERT INTO "${model.tableName}" (`;
+  let query = `INSERT INTO ${model.qualifiedTableName} (`;
   for (const [columnIndex, column] of columnsToInsert.entries()) {
     if (columnIndex > 0) {
       query += ",";
@@ -614,7 +620,7 @@ function getUpdateQueryAndParams({
     }
   }
   const params = [];
-  let query = `UPDATE "${model.tableName}" SET `;
+  let query = `UPDATE ${model.qualifiedTableName} SET `;
   let isFirstProperty = true;
   for (const [propertyName, value] of Object.entries(values)) {
     const column = model.columnsByPropertyName[propertyName];
@@ -701,7 +707,7 @@ function getDeleteQueryAndParams({
   returnRecords = true,
   returnSelect
 }) {
-  let query = `DELETE FROM "${model.tableName}"`;
+  let query = `DELETE FROM ${model.qualifiedTableName}`;
   const { whereStatement, params } = buildWhereStatement({
     repositoriesByModelNameLowered,
     model,
@@ -2297,6 +2303,7 @@ function table(dbNameOrTableOptions, options) {
     const metadataStorage = getMetadataStorage();
     const modelMetadata = new ModelMetadata({
       name: className,
+      schema: options.schema,
       type: classObject,
       tableName: options.name,
       readonly: options.readonly ?? false,

package/dist/index.d.cts

@@ -354,6 +354,7 @@ interface ModelMetadataOptions<T extends Entity> {
     name: string;
     type: EntityStatic<T>;
     connection?: string;
+    schema?: string;
     tableName?: string;
     readonly?: boolean;
 }
@@ -369,15 +370,17 @@ declare class ModelMetadata<T extends Entity> {
     get createDateColumns(): readonly Column[];
     get updateDateColumns(): readonly Column[];
     get versionColumns(): readonly Column[];
+    get qualifiedTableName(): string;
     name: string;
     type: EntityStatic<T>;
     connection?: string;
+    schema?: string;
     tableName: string;
     readonly: boolean;
     columnsByColumnName: ColumnByStringId;
     columnsByPropertyName: ColumnByStringId;
     constructor({ name, //
-    type, connection, tableName, readonly, }: ModelMetadataOptions<T>);
+    type, connection, schema, tableName, readonly, }: ModelMetadataOptions<T>);
 }
 
 /**
@@ -849,6 +852,10 @@ interface TableOptions {
      * Table name in the database
      */
     name?: string;
+    /**
+     * Schema table belongs to in the database
+     */
+    schema?: string;
     /**
      * Connection name to use for queries
      */

package/dist/index.d.mts

@@ -354,6 +354,7 @@ interface ModelMetadataOptions<T extends Entity> {
     name: string;
     type: EntityStatic<T>;
     connection?: string;
+    schema?: string;
     tableName?: string;
     readonly?: boolean;
 }
@@ -369,15 +370,17 @@ declare class ModelMetadata<T extends Entity> {
     get createDateColumns(): readonly Column[];
     get updateDateColumns(): readonly Column[];
     get versionColumns(): readonly Column[];
+    get qualifiedTableName(): string;
     name: string;
     type: EntityStatic<T>;
     connection?: string;
+    schema?: string;
     tableName: string;
     readonly: boolean;
     columnsByColumnName: ColumnByStringId;
     columnsByPropertyName: ColumnByStringId;
     constructor({ name, //
-    type, connection, tableName, readonly, }: ModelMetadataOptions<T>);
+    type, connection, schema, tableName, readonly, }: ModelMetadataOptions<T>);
 }
 
 /**
@@ -849,6 +852,10 @@ interface TableOptions {
      * Table name in the database
      */
     name?: string;
+    /**
+     * Schema table belongs to in the database
+     */
+    schema?: string;
     /**
      * Connection name to use for queries
      */

package/dist/index.d.ts

@@ -354,6 +354,7 @@ interface ModelMetadataOptions<T extends Entity> {
     name: string;
     type: EntityStatic<T>;
     connection?: string;
+    schema?: string;
     tableName?: string;
     readonly?: boolean;
 }
@@ -369,15 +370,17 @@ declare class ModelMetadata<T extends Entity> {
     get createDateColumns(): readonly Column[];
     get updateDateColumns(): readonly Column[];
     get versionColumns(): readonly Column[];
+    get qualifiedTableName(): string;
     name: string;
     type: EntityStatic<T>;
     connection?: string;
+    schema?: string;
     tableName: string;
     readonly: boolean;
     columnsByColumnName: ColumnByStringId;
     columnsByPropertyName: ColumnByStringId;
     constructor({ name, //
-    type, connection, tableName, readonly, }: ModelMetadataOptions<T>);
+    type, connection, schema, tableName, readonly, }: ModelMetadataOptions<T>);
 }
 
 /**
@@ -849,6 +852,10 @@ interface TableOptions {
      * Table name in the database
      */
     name?: string;
+    /**
+     * Schema table belongs to in the database
+     */
+    schema?: string;
     /**
      * Connection name to use for queries
      */

package/dist/index.mjs

@@ -290,9 +290,13 @@ class ModelMetadata {
   get versionColumns() {
     return this._versionDateColumns;
   }
+  get qualifiedTableName() {
+    return `${this.schema ? `"${this.schema}".` : ""}"${this.tableName}"`;
+  }
   name;
   type;
   connection;
+  schema;
   tableName;
   readonly;
   columnsByColumnName = {};
@@ -302,12 +306,14 @@ class ModelMetadata {
     //
     type,
     connection,
+    schema,
     tableName,
     readonly = false
   }) {
     this.name = name;
     this.type = type;
     this.connection = connection;
+    this.schema = schema;
     this.tableName = tableName ?? _.snakeCase(name);
     this.readonly = readonly;
   }
@@ -346,7 +352,7 @@ function getSelectQueryAndParams({
     model,
     select
   });
-  query += ` FROM "${model.tableName}"`;
+  query += ` FROM ${model.qualifiedTableName}`;
   const { whereStatement, params } = buildWhereStatement({
     repositoriesByModelNameLowered,
     model,
@@ -393,7 +399,7 @@ function getCountQueryAndParams({
   model,
   where
 }) {
-  let query = `SELECT count(*) AS "count" FROM "${model.tableName}"`;
+  let query = `SELECT count(*) AS "count" FROM ${model.qualifiedTableName}`;
   const { whereStatement, params } = buildWhereStatement({
     repositoriesByModelNameLowered,
     model,
@@ -483,7 +489,7 @@ function getInsertQueryAndParams({
   }
   const valueCollections = entitiesToInsert.map(() => []);
   const params = [];
-  let query = `INSERT INTO "${model.tableName}" (`;
+  let query = `INSERT INTO ${model.qualifiedTableName} (`;
   for (const [columnIndex, column] of columnsToInsert.entries()) {
     if (columnIndex > 0) {
       query += ",";
@@ -608,7 +614,7 @@ function getUpdateQueryAndParams({
     }
   }
   const params = [];
-  let query = `UPDATE "${model.tableName}" SET `;
+  let query = `UPDATE ${model.qualifiedTableName} SET `;
   let isFirstProperty = true;
   for (const [propertyName, value] of Object.entries(values)) {
     const column = model.columnsByPropertyName[propertyName];
@@ -695,7 +701,7 @@ function getDeleteQueryAndParams({
   returnRecords = true,
   returnSelect
 }) {
-  let query = `DELETE FROM "${model.tableName}"`;
+  let query = `DELETE FROM ${model.qualifiedTableName}`;
   const { whereStatement, params } = buildWhereStatement({
     repositoriesByModelNameLowered,
     model,
@@ -2291,6 +2297,7 @@ function table(dbNameOrTableOptions, options) {
     const metadataStorage = getMetadataStorage();
     const modelMetadata = new ModelMetadata({
       name: className,
+      schema: options.schema,
       type: classObject,
       tableName: options.name,
       readonly: options.readonly ?? false,

package/eslint.config.mjs

@@ -3,6 +3,9 @@ import { config } from 'eslint-config-decent';
 export default [
   ...config({
     tsconfigRootDir: import.meta.dirname,
+    enableJest: false,
+    enableVitest: false,
+    enableTestingLibrary: false,
   }),
   {
     files: ['**/*.ts'],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigal",
-  "version": "13.1.1",
+  "version": "13.2.0",
   "description": "A fast and lightweight orm for postgres and node.js, written in typescript.",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",