Class FromItem<F, J>

constructor

• new FromItem<F extends object = object, J extends Joins = Joins>(
      rawFromExpr: Expression,
      fromAlias: QueryAlias,
      joinAliases: { [key: string]: QueryAlias },
      from: F,
      joins?: J,
  ): FromItem<F, J>

  Type Parameters

  • F extends object = object
  • J extends Joins = Joins

  Parameters

  • rawFromExpr: Expression
  • fromAlias: QueryAlias
  • joinAliases: { [key: string]: QueryAlias }
  • from: F
  • joins: J = ...

  Returns FromItem<F, J>

from

fromAlias

joinAliases

joins

rawFromExpr

as

• as<A extends string>(alias: A): FromItem<F, J>

  Type Parameters

  • A extends string

  Parameters

  • alias: A

  Returns FromItem<F, J>

asClass

• asClass<E extends object>(
      this: FromItem<F extends RowLikeStrict ? F<F> : never, J>,
  ): Table<
      F extends RowLikeStrict ? F<F> : never,
      RowImpl<F extends RowLikeStrict ? F<F> : never> & E,
  >

  Type Parameters

  • E extends object

  Parameters

  • this: FromItem<F extends RowLikeStrict ? F<F> : never, J>

  Returns Table<
      F extends RowLikeStrict ? F<F> : never,
      RowImpl<F extends RowLikeStrict ? F<F> : never> & E,
  >

asFromItem

• asFromItem(): FromItem<F, J>

  Returns FromItem<F, J>

compile

• compile(ctx: Context): RawBuilder<unknown>

  Parameters

  • ctx: Context

  Returns RawBuilder<unknown>

compileJustFrom

• compileJustFrom(ctx: Context, alias?: string): RawBuilder<unknown>

  Parameters

  • ctx: Context
  • Optionalalias: string

  Returns RawBuilder<unknown>

fullOuterJoin

• fullOuterJoin<F2 extends object, A extends string>(
      this: WithFromItem<F, J>,
      j: WithFromItem<F2>,
      as: A,
      on: (
          from: MakeRowNullable<F>,
          js: JoinTables<MakeJoinsNullable<J>> & {
              [a in string]: MakeRowNullable<F2>
          },
      ) => boolean
      | Bool<0 | 1>,
  ): FromItem<
      MakeRowNullable<F>,
      MakeJoinsNullable<J> & {
          [a in string]: {
              on: Bool<0 | 1>;
              row: MakeRowNullable<F2>;
              table: WithFromItem<F2>;
              type: "FULL OUTER JOIN";
          }
      },
  >

  Type Parameters

  • F2 extends object
  • A extends string

  Parameters

  • this: WithFromItem<F, J>
  • j: WithFromItem<F2>
  • as: A
  • on: (
        from: MakeRowNullable<F>,
        js: JoinTables<MakeJoinsNullable<J>> & {
            [a in string]: MakeRowNullable<F2>
        },
    ) => boolean
    | Bool<0 | 1>

  Returns FromItem<
      MakeRowNullable<F>,
      MakeJoinsNullable<J> & {
          [a in string]: {
              on: Bool<0 | 1>;
              row: MakeRowNullable<F2>;
              table: WithFromItem<F2>;
              type: "FULL OUTER JOIN";
          }
      },
  >

getContext

• getContext(ctxIn: Context): Context

  Parameters

  • ctxIn: Context

  Returns Context

join

• join<F2 extends object, A extends string>(
      j: WithFromItem<F2>,
      as: A,
      on: (
          from: F,
          js: JoinTables<J> & { [a in string]: F2 },
      ) => boolean | Bool<0 | 1>,
  ): FromItem<
      F,
      {
          [a in string]: {
              fromItem: WithFromItem<F2, Joins>;
              on: Bool<0 | 1>;
              row: F2;
              type: "JOIN";
          }
      },
  >

  Type Parameters

  • F2 extends object
  • A extends string

  Parameters

  • j: WithFromItem<F2>
  • as: A
  • on: (from: F, js: JoinTables<J> & { [a in string]: F2 }) => boolean | Bool<0 | 1>

  Returns FromItem<
      F,
      {
          [a in string]: {
              fromItem: WithFromItem<F2, Joins>;
              on: Bool<0 | 1>;
              row: F2;
              type: "JOIN";
          }
      },
  >

joinTables

• joinTables(): JoinTables<J>

  Returns JoinTables<J>

joinWithType

• joinWithType<F2 extends object, A extends string>(
      j: WithFromItem<F2>,
      as: A,
      type: JoinType,
      on: (from: F & MakeRowNullable<F>, js: any) => boolean | Bool<0 | 1>,
  ): FromItem<any, any>

  Type Parameters

  • F2 extends object
  • A extends string

  Parameters

  • j: WithFromItem<F2>
  • as: A
  • type: JoinType
  • on: (from: F & MakeRowNullable<F>, js: any) => boolean | Bool<0 | 1>

  Returns FromItem<any, any>

leftJoin

• leftJoin<F2 extends object, A extends string>(
      j: WithFromItem<F2>,
      as: A,
      on: (
          from: F,
          js: JoinTables<J> & { [a in string]: MakeRowNullable<F2> },
      ) => boolean | Bool<0 | 1>,
  ): FromItem<
      F,
      J & {
          [a in string]: {
              fromItem: WithFromItem<F2>;
              on: Bool<0 | 1>;
              row: MakeRowNullable<F2>;
              type: "LEFT JOIN";
          }
      },
  >

  Type Parameters

  • F2 extends object
  • A extends string

  Parameters

  • j: WithFromItem<F2>
  • as: A
  • on: (
        from: F,
        js: JoinTables<J> & { [a in string]: MakeRowNullable<F2> },
    ) => boolean | Bool<0 | 1>

  Returns FromItem<
      F,
      J & {
          [a in string]: {
              fromItem: WithFromItem<F2>;
              on: Bool<0 | 1>;
              row: MakeRowNullable<F2>;
              type: "LEFT JOIN";
          }
      },
  >

rightJoin

• rightJoin<F2 extends object, A extends string>(
      j: WithFromItem<F2>,
      as: A,
      on: (
          from: F,
          js: JoinTables<MakeJoinsNullable<J>> & { [a in string]: F2 },
      ) => boolean | Bool<0 | 1>,
  ): FromItem<
      MakeRowNullable<F>,
      MakeJoinsNullable<J> & {
          [a in string]: {
              fromItem: WithFromItem<F2>;
              on: Bool<0 | 1>;
              row: F2;
              type: "RIGHT JOIN";
          }
      },
  >

  Type Parameters

  • F2 extends object
  • A extends string

  Parameters

  • j: WithFromItem<F2>
  • as: A
  • on: (
        from: F,
        js: JoinTables<MakeJoinsNullable<J>> & { [a in string]: F2 },
    ) => boolean | Bool<0 | 1>

  Returns FromItem<
      MakeRowNullable<F>,
      MakeJoinsNullable<J> & {
          [a in string]: {
              fromItem: WithFromItem<F2>;
              on: Bool<0 | 1>;
              row: F2;
              type: "RIGHT JOIN";
          }
      },
  >

select

• select(this: WithFromItem<F, J>): Select<F, F, J>

  Parameters

  • this: WithFromItem<F, J>

  Returns Select<F, F, J>

• select<S extends object>(
      this: WithFromItem<F, J>,
      cb: (f: F, j: JoinTables<J>) => S,
  ): Select<S, F, J>

  Type Parameters

  • S extends object

  Parameters

  • this: WithFromItem<F, J>
  • cb: (f: F, j: JoinTables<J>) => S

  Returns Select<S, F, J>

• select<S extends object>(
      this: WithFromItem<F, J>,
      cb: (f: F) => S,
  ): Select<S, F, J>

  Type Parameters

  • S extends object

  Parameters

  • this: WithFromItem<F, J>
  • cb: (f: F) => S

  Returns Select<S, F, J>

tableColumnAlias

• tableColumnAlias(): RawBuilder<unknown>

  Returns RawBuilder<unknown>

toSelectArgs

• toSelectArgs(): FromToSelectArgs<F, J>

  Returns FromToSelectArgs<F, J>

Staticof

• of<R extends object>(fromRow: R): typeof __class

  Type Parameters

  • R extends object

  Parameters

  • fromRow: R

  Returns typeof __class

StaticofSchema

• ofSchema<T extends TableSchema>(columns: T): typeof __class

  Type Parameters

  • T extends TableSchema

  Parameters

  • columns: T

  Returns typeof __class