drizzle-orm 0.29.3 → 0.29.4-b475b53

package/pg-core/query-builders/select.js

@@ -147,22 +147,22 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   }
   /**
    * Executes a `left join` operation by adding another table to the current query.
-   * 
+   *
    * Calling this method associates each row of the table with the corresponding row from the joined table, if a match is found. If no matching row exists, it sets all columns of the joined table to null.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/joins#left-join}
-   * 
+   *
    * @param table the table to join.
    * @param on the `on` clause.
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all users and their pets
    * const usersWithPets: { user: User; pets: Pet | null }[] = await db.select()
    *   .from(users)
    *   .leftJoin(pets, eq(users.id, pets.ownerId))
-   * 
+   *
    * // Select userId and petId
    * const usersIdsAndPetIds: { userId: number; petId: number | null }[] = await db.select({
    *   userId: users.id,
@@ -175,22 +175,22 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   leftJoin = this.createJoin("left");
   /**
    * Executes a `right join` operation by adding another table to the current query.
-   * 
+   *
    * Calling this method associates each row of the joined table with the corresponding row from the main table, if a match is found. If no matching row exists, it sets all columns of the main table to null.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/joins#right-join}
-   * 
+   *
    * @param table the table to join.
    * @param on the `on` clause.
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all users and their pets
    * const usersWithPets: { user: User | null; pets: Pet }[] = await db.select()
    *   .from(users)
    *   .rightJoin(pets, eq(users.id, pets.ownerId))
-   * 
+   *
    * // Select userId and petId
    * const usersIdsAndPetIds: { userId: number | null; petId: number }[] = await db.select({
    *   userId: users.id,
@@ -203,22 +203,22 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   rightJoin = this.createJoin("right");
   /**
    * Executes an `inner join` operation, creating a new table by combining rows from two tables that have matching values.
-   * 
+   *
    * Calling this method retrieves rows that have corresponding entries in both joined tables. Rows without matching entries in either table are excluded, resulting in a table that includes only matching pairs.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/joins#inner-join}
-   * 
+   *
    * @param table the table to join.
    * @param on the `on` clause.
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all users and their pets
    * const usersWithPets: { user: User; pets: Pet }[] = await db.select()
    *   .from(users)
    *   .innerJoin(pets, eq(users.id, pets.ownerId))
-   * 
+   *
    * // Select userId and petId
    * const usersIdsAndPetIds: { userId: number; petId: number }[] = await db.select({
    *   userId: users.id,
@@ -231,22 +231,22 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   innerJoin = this.createJoin("inner");
   /**
    * Executes a `full join` operation by combining rows from two tables into a new table.
-   * 
+   *
    * Calling this method retrieves all rows from both main and joined tables, merging rows with matching values and filling in `null` for non-matching columns.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/joins#full-join}
-   * 
+   *
    * @param table the table to join.
    * @param on the `on` clause.
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all users and their pets
    * const usersWithPets: { user: User | null; pets: Pet | null }[] = await db.select()
    *   .from(users)
    *   .fullJoin(pets, eq(users.id, pets.ownerId))
-   * 
+   *
    * // Select userId and petId
    * const usersIdsAndPetIds: { userId: number | null; petId: number | null }[] = await db.select({
    *   userId: users.id,
@@ -271,13 +271,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   }
   /**
    * Adds `union` set operator to the query.
-   * 
+   *
    * Calling this method will combine the result sets of the `select` statements and remove any duplicate rows that appear across them.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/set-operations#union}
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all unique names from customers and users tables
    * await db.select({ name: users.name })
@@ -287,9 +287,9 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
    *   );
    * // or
    * import { union } from 'drizzle-orm/pg-core'
-   * 
+   *
    * await union(
-   *   db.select({ name: users.name }).from(users), 
+   *   db.select({ name: users.name }).from(users),
    *   db.select({ name: customers.name }).from(customers)
    * );
    * ```
@@ -297,13 +297,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   union = this.createSetOperator("union", false);
   /**
    * Adds `union all` set operator to the query.
-   * 
+   *
    * Calling this method will combine the result-set of the `select` statements and keep all duplicate rows that appear across them.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/set-operations#union-all}
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all transaction ids from both online and in-store sales
    * await db.select({ transaction: onlineSales.transactionId })
@@ -313,7 +313,7 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
    *   );
    * // or
    * import { unionAll } from 'drizzle-orm/pg-core'
-   * 
+   *
    * await unionAll(
    *   db.select({ transaction: onlineSales.transactionId }).from(onlineSales),
    *   db.select({ transaction: inStoreSales.transactionId }).from(inStoreSales)
@@ -323,13 +323,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   unionAll = this.createSetOperator("union", true);
   /**
    * Adds `intersect` set operator to the query.
-   * 
+   *
    * Calling this method will retain only the rows that are present in both result sets and eliminate duplicates.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/set-operations#intersect}
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select course names that are offered in both departments A and B
    * await db.select({ courseName: depA.courseName })
@@ -339,7 +339,7 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
    *   );
    * // or
    * import { intersect } from 'drizzle-orm/pg-core'
-   * 
+   *
    * await intersect(
    *   db.select({ courseName: depA.courseName }).from(depA),
    *   db.select({ courseName: depB.courseName }).from(depB)
@@ -349,30 +349,30 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   intersect = this.createSetOperator("intersect", false);
   /**
    * Adds `intersect all` set operator to the query.
-   * 
+   *
    * Calling this method will retain only the rows that are present in both result sets including all duplicates.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/set-operations#intersect-all}
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all products and quantities that are ordered by both regular and VIP customers
-   * await db.select({ 
-   *   productId: regularCustomerOrders.productId, 
+   * await db.select({
+   *   productId: regularCustomerOrders.productId,
    *   quantityOrdered: regularCustomerOrders.quantityOrdered
    * })
    * .from(regularCustomerOrders)
    * .intersectAll(
-   *   db.select({ 
-   *     productId: vipCustomerOrders.productId, 
-   *     quantityOrdered: vipCustomerOrders.quantityOrdered 
+   *   db.select({
+   *     productId: vipCustomerOrders.productId,
+   *     quantityOrdered: vipCustomerOrders.quantityOrdered
    *   })
    *   .from(vipCustomerOrders)
    * );
    * // or
    * import { intersectAll } from 'drizzle-orm/pg-core'
-   * 
+   *
    * await intersectAll(
    *   db.select({
    *     productId: regularCustomerOrders.productId,
@@ -390,13 +390,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   intersectAll = this.createSetOperator("intersect", true);
   /**
    * Adds `except` set operator to the query.
-   * 
+   *
    * Calling this method will retrieve all unique rows from the left query, except for the rows that are present in the result set of the right query.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/set-operations#except}
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all courses offered in department A but not in department B
    * await db.select({ courseName: depA.courseName })
@@ -406,7 +406,7 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
    *   );
    * // or
    * import { except } from 'drizzle-orm/pg-core'
-   * 
+   *
    * await except(
    *   db.select({ courseName: depA.courseName }).from(depA),
    *   db.select({ courseName: depB.courseName }).from(depB)
@@ -416,13 +416,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   except = this.createSetOperator("except", false);
   /**
    * Adds `except all` set operator to the query.
-   * 
+   *
    * Calling this method will retrieve all rows from the left query, except for the rows that are present in the result set of the right query.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/set-operations#except-all}
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all products that are ordered by regular customers but not by VIP customers
    * await db.select({
@@ -439,7 +439,7 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
    * );
    * // or
    * import { exceptAll } from 'drizzle-orm/pg-core'
-   * 
+   *
    * await exceptAll(
    *   db.select({
    *     productId: regularCustomerOrders.productId,
@@ -460,35 +460,35 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
     this.config.setOperators.push(...setOperators);
     return this;
   }
-  /** 
+  /**
    * Adds a `where` clause to the query.
-   * 
+   *
    * Calling this method will select only those rows that fulfill a specified condition.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/select#filtering}
-   * 
+   *
    * @param where the `where` clause.
-   * 
+   *
    * @example
    * You can use conditional operators and `sql function` to filter the rows to be selected.
-   * 
+   *
    * ```ts
    * // Select all cars with green color
    * await db.select().from(cars).where(eq(cars.color, 'green'));
    * // or
    * await db.select().from(cars).where(sql`${cars.color} = 'green'`)
    * ```
-   * 
+   *
    * You can logically combine conditional operators with `and()` and `or()` operators:
-   * 
+   *
    * ```ts
    * // Select all BMW cars with a green color
    * await db.select().from(cars).where(and(eq(cars.color, 'green'), eq(cars.brand, 'BMW')));
-   * 
+   *
    * // Select all cars with the green or blue color
    * await db.select().from(cars).where(or(eq(cars.color, 'green'), eq(cars.color, 'blue')));
    * ```
-  */
+   */
   where(where) {
     if (typeof where === "function") {
       where = where(
@@ -503,15 +503,15 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   }
   /**
    * Adds a `having` clause to the query.
-   * 
+   *
    * Calling this method will select only those rows that fulfill a specified condition. It is typically used with aggregate functions to filter the aggregated data based on a specified condition.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/select#aggregations}
-   * 
+   *
    * @param having the `having` clause.
-   * 
+   *
    * @example
-   * 
+   *
    * ```ts
    * // Select all brands with more than one car
    * await db.select({
@@ -575,13 +575,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   }
   /**
    * Adds a `limit` clause to the query.
-   * 
+   *
    * Calling this method will set the maximum number of rows that will be returned by this query.
    *
    * See docs: {@link https://orm.drizzle.team/docs/select#limit--offset}
-   * 
+   *
    * @param limit the `limit` clause.
-   * 
+   *
    * @example
    *
    * ```ts
@@ -599,13 +599,13 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   }
   /**
    * Adds an `offset` clause to the query.
-   * 
+   *
    * Calling this method will skip a number of rows when returning results from this query.
-   * 
+   *
    * See docs: {@link https://orm.drizzle.team/docs/select#limit--offset}
-   * 
+   *
    * @param offset the `offset` clause.
-   * 
+   *
    * @example
    *
    * ```ts
@@ -623,11 +623,11 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
   }
   /**
    * Adds a `for` clause to the query.
-   * 
+   *
    * Calling this method will specify a lock strength for this query that controls how strictly it acquires exclusive access to the rows being queried.
-   * 
+   *
    * See docs: {@link https://www.postgresql.org/docs/current/sql-select.html#SQL-FOR-UPDATE-SHARE}
-   * 
+   *
    * @param strength the lock strength.
    * @param config the lock configuration.
    */
@@ -662,6 +662,7 @@ class PgSelectQueryBuilderBase extends TypedQueryBuilder {
 }
 class PgSelectBase extends PgSelectQueryBuilderBase {
   static [entityKind] = "PgSelect";
+  /** @internal */
   _prepare(name) {
     const { session, config, dialect, joinsNotNullableMap } = this;
     if (!session) {