Server - Technical Reference - v26.4.1
    Preparing search index...

    Variable operatorsConst

    operators: {
        between: {
            <T>(
                column: Aliased,
                min: SQLWrapper<unknown> | T,
                max: SQLWrapper<unknown> | T,
            ): SQL;
            <TColumn extends AnyColumn>(
                column: TColumn,
                min: SQLWrapper<unknown> | TColumn["_"]["data"],
                max: SQLWrapper<unknown> | TColumn["_"]["data"],
            ): SQL;
            <T extends SQLWrapper<unknown>>(
                column: Exclude<
                    T,
                    Aliased<unknown>
                    | Column<ColumnBaseConfig<ColumnType>, object>,
                >,
                min: unknown,
                max: unknown,
            ): SQL;
        };
        eq: BinaryOperator;
        gt: BinaryOperator;
        gte: BinaryOperator;
        ilike: (
            column:
                | SQL<unknown>
                | SQLWrapper<unknown>
                | Aliased<unknown>
                | Column<ColumnBaseConfig<ColumnType>, object>,
            value: string | SQLWrapper<unknown>,
        ) => SQL;
        inArray: {
            <T>(
                column: Aliased<T>,
                values: SQLWrapper<unknown> | (Placeholder<string, any> | T)[],
            ): SQL;
            <TColumn extends Column<ColumnBaseConfig<ColumnType>, object>>(
                column: TColumn,
                values:
                    | SQLWrapper<unknown>
                    | readonly (Placeholder<string, any> | TColumn["_"]["data"])[],
            ): SQL;
            <T extends SQLWrapper<unknown>>(
                column: Exclude<
                    T,
                    Aliased<unknown>
                    | Column<ColumnBaseConfig<ColumnType>, object>,
                >,
                values: SQLWrapper<unknown> | readonly unknown[],
            ): SQL;
        };
        isNotNull: (value: SQLWrapper) => SQL;
        isNull: (value: SQLWrapper) => SQL;
        like: (
            column:
                | SQL<unknown>
                | SQLWrapper<unknown>
                | Aliased<unknown>
                | Column<ColumnBaseConfig<ColumnType>, object>,
            value: string | SQLWrapper<unknown>,
        ) => SQL;
        lt: BinaryOperator;
        lte: BinaryOperator;
        ne: BinaryOperator;
        notBetween: {
            <T>(
                column: Aliased,
                min: SQLWrapper<unknown> | T,
                max: SQLWrapper<unknown> | T,
            ): SQL;
            <TColumn extends AnyColumn>(
                column: TColumn,
                min: SQLWrapper<unknown> | TColumn["_"]["data"],
                max: SQLWrapper<unknown> | TColumn["_"]["data"],
            ): SQL;
            <T extends SQLWrapper<unknown>>(
                column: Exclude<
                    T,
                    Aliased<unknown>
                    | Column<ColumnBaseConfig<ColumnType>, object>,
                >,
                min: unknown,
                max: unknown,
            ): SQL;
        };
        notIlike: (
            column:
                | SQL<unknown>
                | SQLWrapper<unknown>
                | Aliased<unknown>
                | Column<ColumnBaseConfig<ColumnType>, object>,
            value: string | SQLWrapper<unknown>,
        ) => SQL;
        notInArray: {
            <T>(
                column: Aliased<T>,
                values: SQLWrapper<unknown> | (Placeholder<string, any> | T)[],
            ): SQL;
            <TColumn extends Column<ColumnBaseConfig<ColumnType>, object>>(
                column: TColumn,
                values:
                    | SQLWrapper<unknown>
                    | (Placeholder<string, any> | TColumn["_"]["data"])[],
            ): SQL;
            <T extends SQLWrapper<unknown>>(
                column: Exclude<
                    T,
                    Aliased<unknown>
                    | Column<ColumnBaseConfig<ColumnType>, object>,
                >,
                values: unknown[] | SQLWrapper<unknown>,
            ): SQL;
        };
        notLike: (
            column:
                | SQL<unknown>
                | SQLWrapper<unknown>
                | Aliased<unknown>
                | Column<ColumnBaseConfig<ColumnType>, object>,
            value: string | SQLWrapper<unknown>,
        ) => SQL;
    } = ...

    Type Declaration

    • between: {
          <T>(
              column: Aliased,
              min: SQLWrapper<unknown> | T,
              max: SQLWrapper<unknown> | T,
          ): SQL;
          <TColumn extends AnyColumn>(
              column: TColumn,
              min: SQLWrapper<unknown> | TColumn["_"]["data"],
              max: SQLWrapper<unknown> | TColumn["_"]["data"],
          ): SQL;
          <T extends SQLWrapper<unknown>>(
              column: Exclude<
                  T,
                  Aliased<unknown>
                  | Column<ColumnBaseConfig<ColumnType>, object>,
              >,
              min: unknown,
              max: unknown,
          ): SQL;
      }
    • eq: BinaryOperator

      Test that two values are equal.

      Remember that the SQL standard dictates that two NULL values are not equal, so if you want to test whether a value is null, you may want to use isNull instead.

      // Select cars made by Ford
      db.select().from(cars)
      .where(eq(cars.make, 'Ford'))

      isNull for a way to test equality to NULL.

    • gt: BinaryOperator

      Test that the first expression passed is greater than the second expression.

      // Select cars made after 2000.
      db.select().from(cars)
      .where(gt(cars.year, 2000))

      gte for greater-than-or-equal

    • gte: BinaryOperator

      Test that the first expression passed is greater than or equal to the second expression. Use gt to test whether an expression is strictly greater than another.

      // Select cars made on or after 2000.
      db.select().from(cars)
      .where(gte(cars.year, 2000))

      gt for a strictly greater-than condition

    • ilike: (
          column:
              | SQL<unknown>
              | SQLWrapper<unknown>
              | Aliased<unknown>
              | Column<ColumnBaseConfig<ColumnType>, object>,
          value: string | SQLWrapper<unknown>,
      ) => SQL
    • inArray: {
          <T>(
              column: Aliased<T>,
              values: SQLWrapper<unknown> | (Placeholder<string, any> | T)[],
          ): SQL;
          <TColumn extends Column<ColumnBaseConfig<ColumnType>, object>>(
              column: TColumn,
              values:
                  | SQLWrapper<unknown>
                  | readonly (Placeholder<string, any> | TColumn["_"]["data"])[],
          ): SQL;
          <T extends SQLWrapper<unknown>>(
              column: Exclude<
                  T,
                  Aliased<unknown>
                  | Column<ColumnBaseConfig<ColumnType>, object>,
              >,
              values: SQLWrapper<unknown> | readonly unknown[],
          ): SQL;
      }
    • isNotNull: (value: SQLWrapper) => SQL
    • isNull: (value: SQLWrapper) => SQL
    • like: (
          column:
              | SQL<unknown>
              | SQLWrapper<unknown>
              | Aliased<unknown>
              | Column<ColumnBaseConfig<ColumnType>, object>,
          value: string | SQLWrapper<unknown>,
      ) => SQL
    • lt: BinaryOperator

      Test that the first expression passed is less than the second expression.

      // Select cars made before 2000.
      db.select().from(cars)
      .where(lt(cars.year, 2000))

      lte for less-than-or-equal

    • lte: BinaryOperator

      Test that the first expression passed is less than or equal to the second expression.

      // Select cars made before 2000.
      db.select().from(cars)
      .where(lte(cars.year, 2000))

      lt for a strictly less-than condition

    • ne: BinaryOperator

      Test that two values are not equal.

      Remember that the SQL standard dictates that two NULL values are not equal, so if you want to test whether a value is not null, you may want to use isNotNull instead.

      // Select cars not made by Ford
      db.select().from(cars)
      .where(ne(cars.make, 'Ford'))

      isNotNull for a way to test whether a value is not null.

    • notBetween: {
          <T>(
              column: Aliased,
              min: SQLWrapper<unknown> | T,
              max: SQLWrapper<unknown> | T,
          ): SQL;
          <TColumn extends AnyColumn>(
              column: TColumn,
              min: SQLWrapper<unknown> | TColumn["_"]["data"],
              max: SQLWrapper<unknown> | TColumn["_"]["data"],
          ): SQL;
          <T extends SQLWrapper<unknown>>(
              column: Exclude<
                  T,
                  Aliased<unknown>
                  | Column<ColumnBaseConfig<ColumnType>, object>,
              >,
              min: unknown,
              max: unknown,
          ): SQL;
      }
    • notIlike: (
          column:
              | SQL<unknown>
              | SQLWrapper<unknown>
              | Aliased<unknown>
              | Column<ColumnBaseConfig<ColumnType>, object>,
          value: string | SQLWrapper<unknown>,
      ) => SQL
    • notInArray: {
          <T>(
              column: Aliased<T>,
              values: SQLWrapper<unknown> | (Placeholder<string, any> | T)[],
          ): SQL;
          <TColumn extends Column<ColumnBaseConfig<ColumnType>, object>>(
              column: TColumn,
              values:
                  | SQLWrapper<unknown>
                  | (Placeholder<string, any> | TColumn["_"]["data"])[],
          ): SQL;
          <T extends SQLWrapper<unknown>>(
              column: Exclude<
                  T,
                  Aliased<unknown>
                  | Column<ColumnBaseConfig<ColumnType>, object>,
              >,
              values: unknown[] | SQLWrapper<unknown>,
          ): SQL;
      }
    • notLike: (
          column:
              | SQL<unknown>
              | SQLWrapper<unknown>
              | Aliased<unknown>
              | Column<ColumnBaseConfig<ColumnType>, object>,
          value: string | SQLWrapper<unknown>,
      ) => SQL