pqb 0.18.19 → 0.18.21

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as orchid_core from 'orchid-core';
-import { QueryResultRow, AdapterBase, QueryInput, Sql, QueryBaseCommon, ColumnsShapeBase, QueryInternal, QueryMetaBase, StringKey, Expression, ColumnTypeBase, MaybeArray, TemplateLiteralArgs, ColumnsParsers, getValueKey, ColumnTypesBase, ColumnShapeOutput, DefaultSelectColumns, EmptyObject, DbBase, QueryThen, QueryCatch, TransactionState, SQLQueryArgs, NullableColumn, SetOptional, EmptyTuple, MergeObjects, RawSQLBase, RawSQLValues, ExpressionTypeMethod, DynamicSQLArg, StaticSQLArgs, Spread, Code, OperatorToSQL, BaseNumberData, NumberTypeMethods, ColumnWithDefault, StringTypeData, PrimaryKeyColumn, stringTypeMethods, DateTypeMethods, DateColumnData, EncodeColumn, ParseColumn, JSONType, JSONUnknown, JSONTypes, ArrayMethodsData, arrayTypeMethods, ForeignKeyTable, TimestampHelpers, ColumnNameOfTable, ValidationContext, ErrorMessage, ColumnDataBase } from 'orchid-core';
+import { QueryResultRow, AdapterBase, QueryInput, Sql, QueryBaseCommon, ColumnsShapeBase, QueryInternal, QueryMetaBase, StringKey, Expression, ColumnTypeBase, MaybeArray, TemplateLiteralArgs, ColumnsParsers, getValueKey, ColumnTypesBase, ColumnShapeOutput, DefaultSelectColumns, EmptyObject, DbBase, QueryThen, QueryCatch, TransactionState, SQLQueryArgs, NullableColumn, SetOptional, EmptyTuple, MergeObjects, RawSQLBase, RawSQLValues, ExpressionTypeMethod, DynamicSQLArg, StaticSQLArgs, Spread, Code, OperatorToSQL, BaseNumberData, NumberTypeMethods, ColumnWithDefault, StringTypeData, PrimaryKeyColumn, stringTypeMethods, DateTypeMethods, DateColumnData, EncodeColumn, ParseColumn, JSONType, JSONUnknown, JSONTypes, ArrayMethodsData, arrayTypeMethods, ForeignKeyTable, TimestampHelpers, ColumnNameOfTable, ColumnDataBase, ValidationContext, ErrorMessage } from 'orchid-core';
 import { PoolConfig, Pool, PoolClient } from 'pg';
 import { inspect } from 'node:util';
 import { AsyncLocalStorage } from 'node:async_hooks';
@@ -270,7 +270,7 @@ type CommonQueryData = {
     wrapInTransaction?: boolean;
     throwOnNotFound?: boolean;
     with?: WithItem[];
-    withShapes?: Record<string, ColumnsShape>;
+    withShapes?: Record<string, ColumnsShapeBase>;
     joinTo?: QueryBase;
     joinedShapes?: JoinedShapes;
     joinedParsers?: JoinedParsers;
@@ -437,9 +437,9 @@ declare class OrchidOrmInternalError extends Error {
 }
 type QueryErrorName = 'parseComplete' | 'bindComplete' | 'closeComplete' | 'noData' | 'portalSuspended' | 'replicationStart' | 'emptyQuery' | 'copyDone' | 'copyData' | 'rowDescription' | 'parameterDescription' | 'parameterStatus' | 'backendKeyData' | 'notification' | 'readyForQuery' | 'commandComplete' | 'dataRow' | 'copyInResponse' | 'copyOutResponse' | 'authenticationOk' | 'authenticationMD5Password' | 'authenticationCleartextPassword' | 'authenticationSASL' | 'authenticationSASLContinue' | 'authenticationSASLFinal' | 'error' | 'notice';
 declare abstract class QueryError<T extends {
-    shape: ColumnsShape;
+    shape: ColumnsShapeBase;
 } = {
-    shape: ColumnsShape;
+    shape: ColumnsShapeBase;
 }> extends OrchidOrmInternalError {
     message: string;
     name: QueryErrorName;
@@ -492,8 +492,8 @@ type DbTableOptions = {
     language?: string;
 } & QueryLogOptions;
 type QueryDefaultReturnData<Shape extends ColumnsShapeBase> = Pick<ColumnShapeOutput<Shape>, DefaultSelectColumns<Shape>[number]>[];
-declare const anyShape: Record<string, ColumnType<unknown, BaseOperators, unknown, unknown, unknown>>;
-interface Db<Table extends string | undefined = undefined, Shape extends ColumnsShape = Record<string, never>, Relations extends RelationsBase = EmptyObject, ColumnTypes = DefaultColumnTypes, ShapeWithComputed extends ColumnsShape = Shape, Data = QueryDefaultReturnData<Shape>> extends DbBase<Adapter, Table, Shape, ColumnTypes, ShapeWithComputed>, QueryMethods<ColumnTypes> {
+declare const anyShape: Record<string, ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>>;
+interface Db<Table extends string | undefined = undefined, Shape extends ColumnsShapeBase = Record<string, never>, Relations extends RelationsBase = EmptyObject, ColumnTypes = DefaultColumnTypes, ShapeWithComputed extends ColumnsShapeBase = Shape, Data = QueryDefaultReturnData<Shape>> extends DbBase<Adapter, Table, Shape, ColumnTypes, ShapeWithComputed>, QueryMethods<ColumnTypes> {
     new (adapter: Adapter, queryBuilder: Db<Table, Shape, Relations, ColumnTypes>, table?: Table, shape?: Shape, options?: DbTableOptions): this;
     internal: Query['internal'];
     queryBuilder: Db;
@@ -516,7 +516,7 @@ interface Db<Table extends string | undefined = undefined, Shape extends Columns
         }[keyof Shape], true>;
     };
 }
-declare class Db<Table extends string | undefined = undefined, Shape extends ColumnsShape = Record<string, never>, Relations extends RelationsBase = EmptyObject, ColumnTypes = DefaultColumnTypes, ShapeWithComputed extends ColumnsShape = Shape> implements Query {
+declare class Db<Table extends string | undefined = undefined, Shape extends ColumnsShapeBase = Record<string, never>, Relations extends RelationsBase = EmptyObject, ColumnTypes = DefaultColumnTypes, ShapeWithComputed extends ColumnsShapeBase = Shape> implements Query {
     adapter: Adapter;
     queryBuilder: Db;
     table: Table;
@@ -583,7 +583,7 @@ declare class Db<Table extends string | undefined = undefined, Shape extends Col
     queryArrays<R extends any[] = any[]>(...args: SQLQueryArgs): Promise<QueryArraysResult<R>>;
 }
 type DbResult<ColumnTypes> = Db<string, Record<string, never>, EmptyObject, ColumnTypes> & {
-    <Table extends string, Shape extends ColumnsShape = ColumnsShape>(table: Table, shape?: ((t: ColumnTypes) => Shape) | Shape, options?: DbTableOptions): Db<Table, Shape, EmptyObject>;
+    <Table extends string, Shape extends ColumnsShapeBase = ColumnsShapeBase>(table: Table, shape?: ((t: ColumnTypes) => Shape) | Shape, options?: DbTableOptions): Db<Table, Shape, EmptyObject>;
     adapter: Adapter;
     close: Adapter['close'];
 };
@@ -4371,17 +4371,33 @@ declare class Update {
     updateOrThrow<T extends Query>(this: T, arg: UpdateArg<T>): UpdateResult<T>;
     _updateOrThrow<T extends Query>(this: T, arg: UpdateArg<T>): UpdateResult<T>;
     /**
-     * Increments a column value by the specified amount. Optionally takes `returning` argument.
+     * Increments a column by `1`, returns a count of updated records by default.
      *
      * ```ts
-     * // increment numericColumn column by 1, return updated records
-     * const result = await db.table
-     *   .selectAll()
+     * const updatedCount = await db.table
      *   .where(...conditions)
      *   .increment('numericColumn');
+     * ```
      *
+     * When using `find` or `get` it will throw `NotFoundError` when no records found.
+     *
+     * ```ts
+     * // throws when not found
+     * const updatedCount = await db.table.find(1).increment('numericColumn');
+     *
+     * // also throws when not found
+     * const updatedCount2 = await db.table
+     *   .where(...conditions)
+     *   .get('columnName')
+     *   .increment('numericColumn');
+     * ```
+     *
+     * Provide an object to increment multiple columns with different values.
+     * Use `select` to specify columns to return.
+     *
+     * ```ts
      * // increment someColumn by 5 and otherColumn by 10, return updated records
-     * const result2 = await db.table
+     * const result = await db.table
      *   .selectAll()
      *   .where(...conditions)
      *   .increment({
@@ -4395,17 +4411,33 @@ declare class Update {
     increment<T extends Query>(this: T, data: ChangeCountArg<T>): UpdateResult<T>;
     _increment<T extends Query>(this: T, data: ChangeCountArg<T>): UpdateResult<T>;
     /**
-     * Decrements a column value by the specified amount. Optionally takes `returning` argument.
+     * Decrements a column by `1`, returns a count of updated records by default.
      *
      * ```ts
-     * // decrement numericColumn column by 1, return updated records
-     * const result = await db.table
-     *   .selectAll()
+     * const updatedCount = await db.table
+     *   .where(...conditions)
+     *   .decrement('numericColumn');
+     * ```
+     *
+     * When using `find` or `get` it will throw `NotFoundError` when no records found.
+     *
+     * ```ts
+     * // throws when not found
+     * const updatedCount = await db.table.find(1).decrement('numericColumn');
+     *
+     * // also throws when not found
+     * const updatedCount2 = await db.table
      *   .where(...conditions)
+     *   .get('columnName')
      *   .decrement('numericColumn');
+     * ```
+     *
+     * Provide an object to decrement multiple columns with different values.
+     * Use `select` to specify columns to return.
      *
+     * ```ts
      * // decrement someColumn by 5 and otherColumn by 10, return updated records
-     * const result2 = await db.table
+     * const result = await db.table
      *   .selectAll()
      *   .where(...conditions)
      *   .decrement({
@@ -5622,7 +5654,7 @@ type Query = QueryBase & QueryMethods<unknown> & {
     columnTypes: unknown;
     onQueryBuilder: typeof OnQueryBuilder;
     table?: string;
-    shape: ColumnsShape;
+    shape: ColumnsShapeBase;
     singlePrimaryKey: string;
     primaryKeys: string[];
     inputType: Record<string, unknown>;
@@ -6487,48 +6519,6 @@ declare class ArrayColumn<Item extends ColumnTypeBase> extends ColumnType<Item['
     };
 }
 
-type ColumnsShape = Record<string, ColumnType>;
-declare abstract class ColumnsObject<Shape extends ColumnsShapeBase> extends ColumnType<{
-    [K in keyof Shape]: Shape[K]['type'];
-}, typeof Operators.any, {
-    [K in keyof Shape]: Shape[K]['inputType'];
-}, {
-    [K in keyof Shape]: Shape[K]['outputType'];
-}, {
-    [K in keyof Shape]: Shape[K]['queryType'];
-}> {
-    shape: Shape;
-    dataType: "object";
-    operators: {
-        equals: Operator<any, BooleanColumn>;
-        not: Operator<any, BooleanColumn>;
-        in: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
-        notIn: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
-    };
-    constructor(shape: Shape);
-}
-declare abstract class ArrayOfColumnsObjects<Shape extends ColumnsShapeBase> extends ColumnType<{
-    [K in keyof Shape]: Shape[K]['type'];
-}[], typeof Operators.any, {
-    [K in keyof Shape]: Shape[K]['inputType'];
-}[], {
-    [K in keyof Shape]: Shape[K]['outputType'];
-}[], {
-    [K in keyof Shape]: Shape[K]['queryType'];
-}[]> {
-    shape: Shape;
-    dataType: "array";
-    operators: {
-        equals: Operator<any, BooleanColumn>;
-        not: Operator<any, BooleanColumn>;
-        in: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
-        notIn: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
-    };
-    constructor(shape: Shape);
-}
-declare abstract class PluckResultColumnType<C extends ColumnTypeBase> extends ColumnTypeBase<C['type'][], typeof Operators.any, C['inputType'][], C['outputType'][], C['queryType'][]> {
-}
-
 declare class CustomTypeColumn extends ColumnType<unknown, typeof Operators.any> {
     dataType: string;
     operators: {
@@ -6592,7 +6582,7 @@ declare const getConstraintKind: (it: TableData.Constraint) => 'constraint' | 'f
 declare const newTableData: () => TableData;
 declare const getTableData: () => TableData;
 declare const resetTableData: (data?: TableData) => void;
-declare const getColumnTypes: <ColumnTypes, Shape extends ColumnsShape>(types: ColumnTypes, fn: (t: ColumnTypes) => Shape, nowSQL: string | undefined, language: string | undefined, data?: TableData) => Shape;
+declare const getColumnTypes: <ColumnTypes, Shape extends ColumnsShapeBase>(types: ColumnTypes, fn: (t: ColumnTypes) => Shape, nowSQL: string | undefined, language: string | undefined, data?: TableData) => Shape;
 type DefaultColumnTypes = TimestampHelpers & {
     name<T extends ColumnTypesBase>(this: T, name: string): T;
     sql<T extends ColumnTypesBase>(this: T, sql: TemplateStringsArray, ...values: unknown[]): RawSQLBase<ColumnType, T>;
@@ -6713,7 +6703,7 @@ type ForeignKeyAction = 'NO ACTION' | 'RESTRICT' | 'CASCADE' | 'SET NULL' | 'SET
 type ForeignKey<Table extends string, Columns extends string[]> = ({
     fn(): new () => {
         table: Table;
-        columns: ColumnsShape;
+        columns: ColumnsShapeBase;
     };
 } | {
     table: Table;
@@ -6956,6 +6946,48 @@ declare abstract class ColumnType<Type = unknown, Ops extends BaseOperators = Ba
     generated<T extends ColumnType>(this: T, ...args: StaticSQLArgs): T;
 }
 
+type ColumnsShape = Record<string, ColumnType>;
+declare abstract class ColumnsObject<Shape extends ColumnsShapeBase> extends ColumnType<{
+    [K in keyof Shape]: Shape[K]['type'];
+}, typeof Operators.any, {
+    [K in keyof Shape]: Shape[K]['inputType'];
+}, {
+    [K in keyof Shape]: Shape[K]['outputType'];
+}, {
+    [K in keyof Shape]: Shape[K]['queryType'];
+}> {
+    shape: Shape;
+    dataType: "object";
+    operators: {
+        equals: Operator<any, BooleanColumn>;
+        not: Operator<any, BooleanColumn>;
+        in: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
+        notIn: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
+    };
+    constructor(shape: Shape);
+}
+declare abstract class ArrayOfColumnsObjects<Shape extends ColumnsShapeBase> extends ColumnType<{
+    [K in keyof Shape]: Shape[K]['type'];
+}[], typeof Operators.any, {
+    [K in keyof Shape]: Shape[K]['inputType'];
+}[], {
+    [K in keyof Shape]: Shape[K]['outputType'];
+}[], {
+    [K in keyof Shape]: Shape[K]['queryType'];
+}[]> {
+    shape: Shape;
+    dataType: "array";
+    operators: {
+        equals: Operator<any, BooleanColumn>;
+        not: Operator<any, BooleanColumn>;
+        in: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
+        notIn: Operator<any[] | orchid_core.Expression<ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>> | Query, BooleanColumn>;
+    };
+    constructor(shape: Shape);
+}
+declare abstract class PluckResultColumnType<C extends ColumnTypeBase> extends ColumnTypeBase<C['type'][], typeof Operators.any, C['inputType'][], C['outputType'][], C['queryType'][]> {
+}
+
 declare abstract class VirtualColumn extends ColumnType<unknown, typeof Operators.any> {
     dataType: string;
     operators: {

package/dist/index.js

@@ -8283,6 +8283,12 @@ var __spreadValues$3 = (a, b) => {
 };
 const applyCountChange = (self, op, data) => {
   self.q.type = "update";
+  if (!self.q.select) {
+    if (self.q.returnType === "oneOrThrow" || self.q.returnType === "valueOrThrow") {
+      self.q.throwOnNotFound = true;
+    }
+    self.q.returnType = "rowCount";
+  }
   let map;
   if (typeof data === "object") {
     map = {};
@@ -8600,17 +8606,33 @@ class Update {
     return this._update(arg);
   }
   /**
-   * Increments a column value by the specified amount. Optionally takes `returning` argument.
+   * Increments a column by `1`, returns a count of updated records by default.
    *
    * ```ts
-   * // increment numericColumn column by 1, return updated records
-   * const result = await db.table
-   *   .selectAll()
+   * const updatedCount = await db.table
    *   .where(...conditions)
    *   .increment('numericColumn');
+   * ```
    *
+   * When using `find` or `get` it will throw `NotFoundError` when no records found.
+   *
+   * ```ts
+   * // throws when not found
+   * const updatedCount = await db.table.find(1).increment('numericColumn');
+   *
+   * // also throws when not found
+   * const updatedCount2 = await db.table
+   *   .where(...conditions)
+   *   .get('columnName')
+   *   .increment('numericColumn');
+   * ```
+   *
+   * Provide an object to increment multiple columns with different values.
+   * Use `select` to specify columns to return.
+   *
+   * ```ts
    * // increment someColumn by 5 and otherColumn by 10, return updated records
-   * const result2 = await db.table
+   * const result = await db.table
    *   .selectAll()
    *   .where(...conditions)
    *   .increment({
@@ -8628,17 +8650,33 @@ class Update {
     return applyCountChange(this, "+", data);
   }
   /**
-   * Decrements a column value by the specified amount. Optionally takes `returning` argument.
+   * Decrements a column by `1`, returns a count of updated records by default.
    *
    * ```ts
-   * // decrement numericColumn column by 1, return updated records
-   * const result = await db.table
-   *   .selectAll()
+   * const updatedCount = await db.table
    *   .where(...conditions)
    *   .decrement('numericColumn');
+   * ```
+   *
+   * When using `find` or `get` it will throw `NotFoundError` when no records found.
+   *
+   * ```ts
+   * // throws when not found
+   * const updatedCount = await db.table.find(1).decrement('numericColumn');
    *
+   * // also throws when not found
+   * const updatedCount2 = await db.table
+   *   .where(...conditions)
+   *   .get('columnName')
+   *   .decrement('numericColumn');
+   * ```
+   *
+   * Provide an object to decrement multiple columns with different values.
+   * Use `select` to specify columns to return.
+   *
+   * ```ts
    * // decrement someColumn by 5 and otherColumn by 10, return updated records
-   * const result2 = await db.table
+   * const result = await db.table
    *   .selectAll()
    *   .where(...conditions)
    *   .decrement({