KysoqlHavingExpressionBuilder
Generated API reference for HavingExpressionBuilder in @kysoql/core.
@kysoql/core / HavingExpressionBuilder
Expression helper passed to typed HAVING callbacks.
Type Parameters
| Type Parameter | Default type |
|---|---|
DB | - |
TB extends keyof DB | - |
GroupedBy extends string | - |
GroupingFields extends string | never |
Call Signature
HavingExpressionBuilder<Reference, Operator, Right>(
lhs,
op,
rhs
): HavingExpressionWrapper<DB, TB, GroupedBy>;Builds a typed HAVING comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Reference extends string |
Operator extends | "=" | "!=" | OrderedComparisonOperator | "in" | "not in" | MultiSelectComparisonOperator | "like" |
Right |
Parameters
| Parameter | Type |
|---|---|
lhs | Reference & GroupedHavingFieldName<DB, TB, GroupedBy, Reference> |
op | Operator |
rhs | Right |
Returns
HavingExpressionWrapper<DB, TB, GroupedBy>
Call Signature
HavingExpressionBuilder<Output, Value, AllowedOperator, Operator, Right>(
lhs,
op,
rhs
): HavingExpressionWrapper<DB, TB, GroupedBy>;Builds a typed HAVING comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Output |
Value |
AllowedOperator extends ComparisonOperator |
Operator extends ComparisonOperator |
Right |
Parameters
| Parameter | Type |
|---|---|
lhs | AggregateFunctionExpression<Output, Value, AllowedOperator> |
op | Operator |
rhs | Right |
Returns
HavingExpressionWrapper<DB, TB, GroupedBy>
Call Signature
HavingExpressionBuilder<Output, Value, AllowedOperator, Identity, Operator, Right>(
lhs,
op,
rhs
): HavingExpressionWrapper<DB, TB, GroupedBy>;Builds a typed HAVING comparison from the supplied left operand, operator, and right operand.
Type Parameters
| Type Parameter |
|---|
Output |
Value |
AllowedOperator extends ComparisonOperator |
Identity extends string |
Operator extends ComparisonOperator |
Right |
Parameters
| Parameter | Type |
|---|---|
lhs | DateFunctionExpression<Output, Value, AllowedOperator, Identity> |
op | Operator |
rhs | Right |
Returns
HavingExpressionWrapper<DB, TB, GroupedBy>
Methods
and()
and(expressions): HavingExpressionWrapper<DB, TB, GroupedBy>;Combines two or more expressions with boolean AND.
Parameters
| Parameter | Type |
|---|---|
expressions | readonly [HavingExpressionWrapper<DB, TB, GroupedBy>, HavingExpressionWrapper<DB, TB, GroupedBy>, HavingExpressionWrapper<DB, TB, GroupedBy>] |
Returns
HavingExpressionWrapper<DB, TB, GroupedBy>
not()
not(expression): HavingExpressionWrapper<DB, TB, GroupedBy>;Negates an expression with boolean NOT.
Parameters
| Parameter | Type |
|---|---|
expression | HavingExpressionWrapper<DB, TB, GroupedBy> |
Returns
HavingExpressionWrapper<DB, TB, GroupedBy>
or()
or(expressions): HavingExpressionWrapper<DB, TB, GroupedBy>;Combines two or more expressions with boolean OR.
Parameters
| Parameter | Type |
|---|---|
expressions | readonly [HavingExpressionWrapper<DB, TB, GroupedBy>, HavingExpressionWrapper<DB, TB, GroupedBy>, HavingExpressionWrapper<DB, TB, GroupedBy>] |
Returns
HavingExpressionWrapper<DB, TB, GroupedBy>
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
fn | readonly | AggregateFunctionModule<DB, TB, GroupingFields> | Function helpers available in this expression context. |