Class Values<R>

Values represents a VALUES clause in SQL It extends FromItem so it can be used in FROM clauses, but is a distinct type so we can match on it specifically for INSERT

Type Parameters

R extends RowLikeStrict = RowLikeStrict

Hierarchy (View Summary)

FromItem<R>
- Values

Index

Constructors

constructor

new Values<R extends RowLikeStrict = RowLikeStrict>(
rows: [R, ...AnyOrParsed<R>[]],
): Values<R>
Type Parameters
- R extends RowLikeStrict = RowLikeStrict
Parameters
- rows: [R, ...AnyOrParsed<R>[]]
Returns Values<R>
Overrides FromItem.constructor
- Defined in query/from-item.ts:310

Properties

from

from: R

fromAlias

fromAlias: QueryAlias

joinAliases

joinAliases: { [key: string]: QueryAlias }

joins

joins: Joins = ...

rawFromExpr

rawFromExpr: Expression

rows

rows: [
    R,
    ...Expand<
        { [key in string
        | number
        | symbol]: R[key] | ScalarResult<R[key]> },
    >[],
]

Methods

as

as<A extends string>(alias: A): FromItem<R, Joins>
Type Parameters
- A extends string
Parameters
- alias: A
Returns FromItem<R, Joins>
Inherited from FromItem.as
- Defined in query/from-item.ts:101

asClass

asClass<E extends object>(
    this: FromItem<R extends RowLikeStrict ? R<R> : never, Joins>,
): Table<
    R extends RowLikeStrict ? R<R> : never,
    RowImpl<R extends RowLikeStrict ? R<R> : never> & E,
>
Type Parameters
- E extends object
Parameters
- this: FromItem<R extends RowLikeStrict ? R<R> : never, Joins>
Returns Table<
R extends RowLikeStrict ? R<R> : never,
RowImpl<R extends RowLikeStrict ? R<R> : never> & E,
>
Inherited from FromItem.asClass
- Defined in query/from-item.ts:299

asFromItem

asFromItem(): FromItem<R, Joins>
Returns FromItem<R, Joins>
Inherited from FromItem.asFromItem
- Defined in query/from-item.ts:112

compile

compile(ctx: Context): RawBuilder<unknown>
Parameters
- ctx: Context
Returns RawBuilder<unknown>
Inherited from FromItem.compile
- Defined in query/from-item.ts:269

compileJustFrom

compileJustFrom(ctx: Context, alias?: string): RawBuilder<unknown>
Parameters
- ctx: Context
- Optionalalias: string
Returns RawBuilder<unknown>
Inherited from FromItem.compileJustFrom
- Defined in query/from-item.ts:263

fullOuterJoin

fullOuterJoin<F2 extends object, A extends string>(
    this: WithFromItem<R, Joins>,
    j: WithFromItem<F2>,
    as: A,
    on: (
        from: MakeRowNullable<R>,
        js: JoinTables<MakeJoinsNullable<Joins>> & {
            [a in string]: MakeRowNullable<F2>
        },
    ) => boolean
    | Bool<0 | 1>,
): FromItem<
    MakeRowNullable<R>,
    MakeJoinsNullable<Joins> & {
        [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<R, Joins>
- j: WithFromItem<F2>
- as: A
- on: (
      from: MakeRowNullable<R>,
      js: JoinTables<MakeJoinsNullable<Joins>> & {
          [a in string]: MakeRowNullable<F2>
      },
  ) => boolean
  | Bool<0 | 1>
Returns FromItem<
    MakeRowNullable<R>,
    MakeJoinsNullable<Joins> & {
        [a in string]: {
            on: Bool<0 | 1>;
            row: MakeRowNullable<F2>;
            table: WithFromItem<F2>;
            type: "FULL OUTER JOIN";
        }
    },
>
Inherited from FromItem.fullOuterJoin
- Defined in query/from-item.ts:235

getContext

getContext(ctxIn: Context): Context
Parameters
- ctxIn: Context
Returns Context
Inherited from FromItem.getContext
- Defined in query/from-item.ts:259

getRowLike

getRowLike(): R
Returns R
- Defined in query/from-item.ts:315

join

join<F2 extends object, A extends string>(
    j: WithFromItem<F2>,
    as: A,
    on: (
        from: R,
        js: JoinTables<Joins> & { [a in string]: F2 },
    ) => boolean | Bool<0 | 1>,
): FromItem<
    R,
    {
        [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: R,
  js: JoinTables<Joins> & { [a in string]: F2 },
  ) => boolean | Bool<0 | 1>
Returns FromItem<
    R,
    {
        [a in string]: {
            fromItem: WithFromItem<F2, Joins>;
            on: Bool<0 | 1>;
            row: F2;
            type: "JOIN";
        }
    },
>
Inherited from FromItem.join
- Defined in query/from-item.ts:161

joinTables

joinTables(): JoinTables<Joins>
Returns JoinTables<Joins>
Inherited from FromItem.joinTables
- Defined in query/from-item.ts:120

joinWithType

joinWithType<F2 extends object, A extends string>(
    j: WithFromItem<F2>,
    as: A,
    type: JoinType,
    on: (from: R & MakeRowNullable<R>, 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: R & MakeRowNullable<R>, js: any) => boolean | Bool<0 | 1>
Returns FromItem<any, any>
Inherited from FromItem.joinWithType
- Defined in query/from-item.ts:126

leftJoin

leftJoin<F2 extends object, A extends string>(
    j: WithFromItem<F2>,
    as: A,
    on: (
        from: R,
        js: JoinTables<Joins> & { [a in string]: MakeRowNullable<F2> },
    ) => boolean | Bool<0 | 1>,
): FromItem<
    R,
    Joins & {
        [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: R,
  js: JoinTables<Joins> & { [a in string]: MakeRowNullable<F2> },
  ) => boolean | Bool<0 | 1>
Returns FromItem<
    R,
    Joins & {
        [a in string]: {
            fromItem: WithFromItem<F2>;
            on: Bool<0 | 1>;
            row: MakeRowNullable<F2>;
            type: "LEFT JOIN";
        }
    },
>
Inherited from FromItem.leftJoin
- Defined in query/from-item.ts:179

rightJoin

rightJoin<F2 extends object, A extends string>(
    j: WithFromItem<F2>,
    as: A,
    on: (
        from: R,
        js: JoinTables<MakeJoinsNullable<Joins>> & { [a in string]: F2 },
    ) => boolean | Bool<0 | 1>,
): FromItem<
    MakeRowNullable<R>,
    MakeJoinsNullable<Joins> & {
        [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: R,
  js: JoinTables<MakeJoinsNullable<Joins>> & { [a in string]: F2 },
  ) => boolean | Bool<0 | 1>
Returns FromItem<
    MakeRowNullable<R>,
    MakeJoinsNullable<Joins> & {
        [a in string]: {
            fromItem: WithFromItem<F2>;
            on: Bool<0 | 1>;
            row: F2;
            type: "RIGHT JOIN";
        }
    },
>
Inherited from FromItem.rightJoin
- Defined in query/from-item.ts:202

select

select(this: WithFromItem<R, Joins>): Select<R, R, Joins>
Parameters
- this: WithFromItem<R, Joins>
Returns Select<R, R, Joins>
Inherited from FromItem.select
- Defined in query/from-item.ts:287
select<S extends object>(
this: WithFromItem<R, Joins>,
cb: (f: R, j: JoinTables<Joins>) => S,
): Select<S, R, Joins>
Type Parameters
- S extends object
Parameters
- this: WithFromItem<R, Joins>
- cb: (f: R, j: JoinTables<Joins>) => S
Returns Select<S, R, Joins>
Inherited from FromItem.select
- Defined in query/from-item.ts:288
select<S extends object>(
this: WithFromItem<R, Joins>,
cb: (f: R) => S,
): Select<S, R, Joins>
Type Parameters
- S extends object
Parameters
- this: WithFromItem<R, Joins>
- cb: (f: R) => S
Returns Select<S, R, Joins>
Inherited from FromItem.select
- Defined in query/from-item.ts:289

tableColumnAlias

tableColumnAlias(): RawBuilder<unknown>
Returns RawBuilder<unknown>
Inherited from FromItem.tableColumnAlias
- Defined in query/from-item.ts:280

toSelectArgs

toSelectArgs(): FromToSelectArgs<R, Joins>
Returns FromToSelectArgs<R, Joins>
Inherited from FromItem.toSelectArgs
- Defined in query/from-item.ts:116

`Static`isValues

isValues(value: unknown): value is Values<any>
Parameters
- value: unknown
Returns value is Values<any>
- Defined in query/from-item.ts:319

`Static`of

of<R extends object>(fromRow: R): typeof __class
Type Parameters
- R extends object
Parameters
- fromRow: R
Returns typeof __class
Inherited from FromItem.of
- Defined in query/from-item.ts:92

`Static`ofSchema

ofSchema<T extends TableSchema>(columns: T): typeof __class
Type Parameters
- T extends TableSchema
Parameters
- columns: T
Returns typeof __class
Inherited from FromItem.ofSchema
- Defined in query/from-item.ts:85

Class Values<R>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Values<R>

Properties

from

fromAlias

joinAliases

joins

rawFromExpr

rows

Methods

as

Type Parameters

Parameters

Returns FromItem<R, Joins>

asClass

Type Parameters

Parameters

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

asFromItem

Returns FromItem<R, Joins>

compile

Parameters

Returns RawBuilder<unknown>

compileJustFrom

Parameters

Returns RawBuilder<unknown>

fullOuterJoin

Type Parameters

Parameters

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

getContext

Parameters

Returns Context

getRowLike

Returns R

join

Type Parameters

Parameters

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

joinTables

Returns JoinTables<Joins>

joinWithType

Type Parameters

Parameters

Returns FromItem<any, any>

leftJoin

Type Parameters

Parameters

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

rightJoin

Type Parameters

Parameters

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

select

Parameters

Returns Select<R, R, Joins>

Type Parameters

Parameters

Returns Select<S, R, Joins>

Type Parameters

Parameters

Returns Select<S, R, Joins>

tableColumnAlias

Returns RawBuilder<unknown>

toSelectArgs

Returns FromToSelectArgs<R, Joins>

StaticisValues

Parameters

Returns value is Values<any>

Staticof

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

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

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

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

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

`Static`isValues

`Static`of

`Static`ofSchema