Variable aggregateConst

Type Declaration

• avg: function

  • avg<S extends OutputSchema<any> | undefined = undefined>(
        column: SelectableColumn,
        options?: AggregateOptions<S>,
    ): AggregateExpression<AggregateResult<S, string | null>>

    Describe AVG(column), preserving database numeric text or null by default. An output parser can explicitly convert it to a number or domain decimal type. Text output cannot recover precision already lost in floating-point storage.

    Type Parameters

    • S extends OutputSchema<any> | undefined = undefined

    Parameters

    • column: SelectableColumn
    • Optionaloptions: AggregateOptions<S>

    Returns AggregateExpression<AggregateResult<S, string | null>>

• count: function

  • count<S extends OutputSchema<any> | undefined = undefined>(
        column?: SelectableColumn,
        options?: AggregateOptions<S>,
    ): AggregateExpression<AggregateResult<S, number>>

    Describe COUNT(*) or COUNT(column) for a typed projection or HAVING clause.

    Type Parameters

    • S extends OutputSchema<any> | undefined = undefined

    Parameters

    • Optionalcolumn: SelectableColumn

      Omit to count rows; supply a column to count its non-null values.

    • Optionaloptions: AggregateOptions<S>

      Optional raw-value parser; use undefined as column for custom COUNT(*).

    Returns AggregateExpression<AggregateResult<S, number>>

    An expression decoded as a safe number unless a parser is supplied.

    Throws

    During execution if the default result exceeds the safe integer range.

• countDistinct: function

  • countDistinct<S extends OutputSchema<any> | undefined = undefined>(
        column: SelectableColumn,
        options?: AggregateOptions<S>,
    ): AggregateExpression<AggregateResult<S, number>>

    Describe COUNT(DISTINCT column), excluding nulls.

    Type Parameters

    • S extends OutputSchema<any> | undefined = undefined

    Parameters

    • column: SelectableColumn
    • Optionaloptions: AggregateOptions<S>

      Optional parser replacing checked safe-integer decoding.

    Returns AggregateExpression<AggregateResult<S, number>>

    A typed aggregate expression, not an executed query.

• max: function

  • max<
        C extends SelectableColumn,
        S extends OutputSchema<any> | undefined = undefined,
    >(
        column: C,
        options?: AggregateOptions<S>,
    ): AggregateExpression<AggregateResult<S, ExtremumValue<C>>>

    Describe MAX(column), returning the column representation or null. Numeric/decimal/bigint SQL overrides preserve exact strings; dates return Date. An optional output parser replaces this decoding policy.

    Type Parameters

    • C extends SelectableColumn
    • S extends OutputSchema<any> | undefined = undefined

    Parameters

    • column: C
    • Optionaloptions: AggregateOptions<S>

    Returns AggregateExpression<AggregateResult<S, ExtremumValue<C>>>

• min: function

  • min<
        C extends SelectableColumn,
        S extends OutputSchema<any> | undefined = undefined,
    >(
        column: C,
        options?: AggregateOptions<S>,
    ): AggregateExpression<AggregateResult<S, ExtremumValue<C>>>

    Describe MIN(column), returning the column representation or null. Numeric/decimal/bigint SQL overrides preserve exact strings; dates return Date. An optional output parser replaces this decoding policy.

    Type Parameters

    • C extends SelectableColumn
    • S extends OutputSchema<any> | undefined = undefined

    Parameters

    • column: C
    • Optionaloptions: AggregateOptions<S>

    Returns AggregateExpression<AggregateResult<S, ExtremumValue<C>>>

• sum: function

  • sum<S extends OutputSchema<any> | undefined = undefined>(
        column: SelectableColumn,
        options?: AggregateOptions<S>,
    ): AggregateExpression<AggregateResult<S, string | null>>

    Describe SUM(column) with exact database numeric text as the default result. Empty/all-null inputs produce null. An output parser receives the raw driver value and takes responsibility for precision and null handling.

    Type Parameters

    • S extends OutputSchema<any> | undefined = undefined

    Parameters

    • column: SelectableColumn
    • Optionaloptions: AggregateOptions<S>

    Returns AggregateExpression<AggregateResult<S, string | null>>