Class InsertBuilder<Schema, Table, Return, Ext>

constructor

• new InsertBuilder<Schema, Table, Return, Ext>(_statement, fn): InsertBuilder<Schema, Table, Return, Ext>

• Type Parameters

  • Schema

  • Table

  • Return

  • Ext extends BuilderExtension

  Parameters

  • _statement: ast.Insert<Ext>

  • fn: Functions<Schema, Table, Ext>

  Returns InsertBuilder<Schema, Table, Return, Ext>

Readonly _statement

Readonly fn

apply

• apply<T>(fn): T

• Type Parameters

  • T

  Parameters

  • fn: ((arg) => T)

    • • (arg): T

      • Parameters

        • arg: InsertBuilder<Schema, Table, Return, Ext>

        Returns T

  Returns T

build

• build(): Statement<Ext>

• Returns Statement<Ext>

columns

• columns(...columns): Omit<InsertBuilder<Schema, Table, Return, Ext>, "columns">

• When inserting values SIJ automatically determines the columns of your dataset by traversing all the keys in all the values. In large datasets this can be a performance issue so you can use columns to specify the columns manually and avoid the extra computation.

  Parameters

  • Rest ...columns: (keyof Table)[]

  Returns Omit<InsertBuilder<Schema, Table, Return, Ext>, "columns">

fromQuery

• fromQuery<QReturn>(query): Omit<InsertBuilder<Schema, Table, Return, Ext>, "values" | "columns" | "values1">

• Insert the result of a query into the table. You cannot insert further values if inserting from a query.

  Type Parameters

  • QReturn extends {
        [Key in string | number | symbol]?: Table[Key]
    }

  Parameters

  • query: QueryBuilder<Schema, any, QReturn, Ext>

  Returns Omit<InsertBuilder<Schema, Table, Return, Ext>, "values" | "columns" | "values1">

lit

• lit<Return>(l): TypedAst<Schema, Return, Expr<Ext>>

• Allows you to insert a literal into the query.

  Type Parameters

  • Return extends null | string | number | boolean

  Parameters

  • l: Return

  Returns TypedAst<Schema, Return, Expr<Ext>>

values

• values(...vs): Omit<InsertBuilder<Schema, Table, Return, Ext>, "columns" | "fromQuery">

• Parameters

  • Rest ...vs: {
        [Key in string | number | symbol]?: ast.DefaultValue | Table[Key] | TypedAst<Schema, Table[Key], Expr<Ext>>
    }[]

  Returns Omit<InsertBuilder<Schema, Table, Return, Ext>, "columns" | "fromQuery">

values1

• values1(...vs): Omit<InsertBuilder<Schema, Table, Return, Ext>, "columns" | "fromQuery">

• When inserting values SIJ automatically determines the columns of your dataset by traversing all the keys in all the values. In large datasets this can be a performance issue. values1 only looks at the first value in your dataset to determine the columns.

  Parameters

  • Rest ...vs: {
        [Key in string | number | symbol]?: ast.DefaultValue | Table[Key] | TypedAst<Schema, Table[Key], Expr<Ext>>
    }[]

  Returns Omit<InsertBuilder<Schema, Table, Return, Ext>, "columns" | "fromQuery">