@uwdata/mosaic-sql/dist/src/functions/operators.d.ts

SQL query construction and analysis.

import type { ExprValue, ExprVarArgs } from '../types.js';
import { BetweenOpNode, NotBetweenOpNode } from '../ast/between-op.js';
import { BinaryOpNode } from '../ast/binary-op.js';
import { InOpNode } from '../ast/in-op.js';
import { AndNode, OrNode } from '../ast/logical-op.js';
import { UnaryOpNode, UnaryPostfixOpNode } from '../ast/unary-op.js';
/**
 * Logical and (AND) operator.
 * @param clauses The input expressions.
 */
export declare function and(...clauses: ExprVarArgs[]): AndNode<import("../index.js").ExprNode>;
/**
 * Logical or (OR) operator.
 * @param clauses The input expressions.
 */
export declare function or(...clauses: ExprVarArgs[]): OrNode<import("../index.js").ExprNode>;
/**
 * Logical not (NOT) operator.
 * @param expr The expression to negate.
 */
export declare function not(expr: ExprValue): UnaryOpNode;
/**
 * Null check (IS NULL) operator.
 * @param expr The expression to test.
 */
export declare function isNull(expr: ExprValue): UnaryPostfixOpNode;
/**
 * Non-null check (IS NOT NULL) operator.
 * @param expr The expression to test.
 */
export declare function isNotNull(expr: ExprValue): UnaryPostfixOpNode;
/**
 * Bitwise not (~) operator.
 * @param expr The input expression.
 */
export declare function bitNot(expr: ExprValue): UnaryOpNode;
/**
 * Bitwise and (&) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function bitAnd(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Bitwise or (|) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function bitOr(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Bit shift left (<<) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function bitLeft(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Bit shift right (>>) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function bitRight(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Addition (+) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function add(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Subtraction (-) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function sub(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Multiplication (*) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function mul(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Division (/) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function div(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Integer division (//) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function idiv(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Modulo (%) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function mod(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Exponentiation (**) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function pow(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Equality comparision (=) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function eq(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Non-equality comparision (<>) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function neq(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Less-than comparision (<) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function lt(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Greater-than comparision (>) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function gt(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Less-than or equal comparision (<=) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function lte(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Greater-than or equal comparision (>=) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function gte(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Null-inclusive non-equality (IS DISTINCT FROM) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function isDistinct(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Null-inclusive equality (IS NOT DISTINCT FROM) operator.
 * @param left The left argument.
 * @param right The right argument.
 */
export declare function isNotDistinct(left: ExprValue, right: ExprValue): BinaryOpNode;
/**
 * Range inclusion (BETWEEN) operator.
 * @param expr The expression to test.
 * @param extent The range extent.
 */
export declare function isBetween(expr: ExprValue, extent?: ExprValue[] | null): BetweenOpNode;
/**
 * Range exclusion (NOT BETWEEN) operator.
 * @param expr The expression to test.
 * @param extent The range extent.
 */
export declare function isNotBetween(expr: ExprValue, extent?: ExprValue[] | null): NotBetweenOpNode;
/**
 * Set inclusion (IN) operator.
 * @param expr The expression to test.
 * @param values The included values.
 */
export declare function isIn(expr: ExprValue, values: ExprValue[]): InOpNode;
//# sourceMappingURL=operators.d.ts.map