Initial commit

node_modules/drizzle-orm/sql/functions/aggregate.d.ts

@@ -0,0 +1,104 @@
+import { type AnyColumn } from "../../column.js";
+import { type SQL, type SQLWrapper } from "../sql.js";
+/**
+ * Returns the number of values in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Number employees with null values
+ * db.select({ value: count() }).from(employees)
+ * // Number of employees where `name` is not null
+ * db.select({ value: count(employees.name) }).from(employees)
+ * ```
+ *
+ * @see countDistinct to get the number of non-duplicate values in `expression`
+ */
+export declare function count(expression?: SQLWrapper): SQL<number>;
+/**
+ * Returns the number of non-duplicate values in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Number of employees where `name` is distinct
+ * db.select({ value: countDistinct(employees.name) }).from(employees)
+ * ```
+ *
+ * @see count to get the number of values in `expression`, including duplicates
+ */
+export declare function countDistinct(expression: SQLWrapper): SQL<number>;
+/**
+ * Returns the average (arithmetic mean) of all non-null values in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Average salary of an employee
+ * db.select({ value: avg(employees.salary) }).from(employees)
+ * ```
+ *
+ * @see avgDistinct to get the average of all non-null and non-duplicate values in `expression`
+ */
+export declare function avg(expression: SQLWrapper): SQL<string | null>;
+/**
+ * Returns the average (arithmetic mean) of all non-null and non-duplicate values in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Average salary of an employee where `salary` is distinct
+ * db.select({ value: avgDistinct(employees.salary) }).from(employees)
+ * ```
+ *
+ * @see avg to get the average of all non-null values in `expression`, including duplicates
+ */
+export declare function avgDistinct(expression: SQLWrapper): SQL<string | null>;
+/**
+ * Returns the sum of all non-null values in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Sum of every employee's salary
+ * db.select({ value: sum(employees.salary) }).from(employees)
+ * ```
+ *
+ * @see sumDistinct to get the sum of all non-null and non-duplicate values in `expression`
+ */
+export declare function sum(expression: SQLWrapper): SQL<string | null>;
+/**
+ * Returns the sum of all non-null and non-duplicate values in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // Sum of every employee's salary where `salary` is distinct (no duplicates)
+ * db.select({ value: sumDistinct(employees.salary) }).from(employees)
+ * ```
+ *
+ * @see sum to get the sum of all non-null values in `expression`, including duplicates
+ */
+export declare function sumDistinct(expression: SQLWrapper): SQL<string | null>;
+/**
+ * Returns the maximum value in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // The employee with the highest salary
+ * db.select({ value: max(employees.salary) }).from(employees)
+ * ```
+ */
+export declare function max<T extends SQLWrapper>(expression: T): SQL<(T extends AnyColumn ? T['_']['data'] : string) | null>;
+/**
+ * Returns the minimum value in `expression`.
+ *
+ * ## Examples
+ *
+ * ```ts
+ * // The employee with the lowest salary
+ * db.select({ value: min(employees.salary) }).from(employees)
+ * ```
+ */
+export declare function min<T extends SQLWrapper>(expression: T): SQL<(T extends AnyColumn ? T['_']['data'] : string) | null>;