Interface MultiTableReturningInterface<DB, TB, O>

interface MultiTableReturningInterface<DB, TB extends keyof DB, O> {
    returning<
        SE extends
            | string
            | AliasedExpression<any, any>
            | DynamicReferenceBuilder<any>
            | AliasedExpressionFactory<DB, TB>,
    >(
        selections: readonly SE[],
    ): ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>;
    returning<const CB extends SelectCallback<DB, TB>>(
        callback: CB,
    ): ReturningInterface<DB, TB, ReturningCallbackRow<DB, TB, O, CB>>;
    returning<
        SE extends
            | string
            | AliasedExpression<any, any>
            | DynamicReferenceBuilder<any>
            | AliasedExpressionFactory<DB, TB>,
    >(
        selection: SE,
    ): ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>;
    returningAll<T extends string | number | symbol>(
        tables: readonly T[],
    ): MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>;
    returningAll<T extends string | number | symbol>(
        table: T,
    ): MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>;
    returningAll(): ReturningInterface<DB, TB, Selectable<DB[TB]>>;
}

Type Parameters

DB
TB extends keyof DB
O

Hierarchy (View Summary)

ReturningInterface<DB, TB, O>
- MultiTableReturningInterface

Implemented by

Index

Methods

returning returningAll

Methods

returning

returning<
    SE extends
        | string
        | AliasedExpression<any, any>
        | DynamicReferenceBuilder<any>
        | AliasedExpressionFactory<DB, TB>,
>(
    selections: readonly SE[],
): ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>

Allows you to return data from modified rows.

On supported databases like PostgreSQL, this method can be chained to insert, update, delete and merge queries to return data.

Also see the returningAll method.

Examples

Return one column:

const { id } = await db
  .insertInto('person')
  .values({
    first_name: 'Jennifer',
    last_name: 'Aniston'
  })
  .returning('id')
  .executeTakeFirstOrThrow()

Return multiple columns:

const { id, last_name } = await db
  .insertInto('person')
  .values({
    first_name: 'Jennifer',
    last_name: 'Aniston'
  })
  .returning(['id', 'last_name'])
  .executeTakeFirstOrThrow()

Return arbitrary expressions:

import { sql } from 'kysely'

const { id, full_name, first_pet_id } = await db
  .insertInto('person')
  .values({
    first_name: 'Jennifer',
    last_name: 'Aniston'
  })
  .returning((eb) => [
    'id as id',
    sql<string>`concat(first_name, ' ', last_name)`.as('full_name'),
    eb.selectFrom('pet').select('pet.id').limit(1).as('first_pet_id')
  ])
  .executeTakeFirstOrThrow()

Type Parameters

SE extends
    | string
    | AliasedExpression<any, any>
    | DynamicReferenceBuilder<any>
    | AliasedExpressionFactory<DB, TB>

Parameters

selections: readonly SE[]

Returns ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>

returning<const CB extends SelectCallback<DB, TB>>(
callback: CB,
): ReturningInterface<DB, TB, ReturningCallbackRow<DB, TB, O, CB>>
Type Parameters
- const CB extends SelectCallback<DB, TB>
Parameters
- callback: CB
Returns ReturningInterface<DB, TB, ReturningCallbackRow<DB, TB, O, CB>>
Inherited from ReturningInterface.returning
- Defined in query-builder/returning-interface.ts:72
returning<
    SE extends
        | string
        | AliasedExpression<any, any>
        | DynamicReferenceBuilder<any>
        | AliasedExpressionFactory<DB, TB>,
>(
    selection: SE,
): ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>
Type Parameters
- SE extends
      | string
      | AliasedExpression<any, any>
      | DynamicReferenceBuilder<any>
      | AliasedExpressionFactory<DB, TB>
Parameters
- selection: SE
Returns ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>
Inherited from ReturningInterface.returning
- Defined in query-builder/returning-interface.ts:76

returningAll

returningAll<T extends string | number | symbol>(
tables: readonly T[],
): MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>
Adds a returning * or returning table.* to an insert/update/delete/merge query on databases that support returning such as PostgreSQL.

Also see the returning method.
Type Parameters
- T extends string | number | symbol
Parameters
- tables: readonly T[]
Returns MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>
Overrides ReturningInterface.returningAll
- Defined in query-builder/returning-interface.ts:100
returningAll<T extends string | number | symbol>(
table: T,
): MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>
Adds a returning * to an insert/update/delete/merge query on databases that support returning such as PostgreSQL.

Also see the returning method.
Type Parameters
- T extends string | number | symbol
Parameters
- table: T
Returns MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>
Overrides ReturningInterface.returningAll
- Defined in query-builder/returning-interface.ts:104
returningAll(): ReturningInterface<DB, TB, Selectable<DB[TB]>>
Adds a returning * to an insert/update/delete/merge query on databases that support returning such as PostgreSQL.

Also see the returning method.

Returns ReturningInterface<DB, TB, Selectable<DB[TB]>>
Overrides ReturningInterface.returningAll
- Defined in query-builder/returning-interface.ts:108

Interface MultiTableReturningInterface<DB, TB, O>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

returning

Examples

Type Parameters

Parameters

Returns ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>

Type Parameters

Parameters

Returns ReturningInterface<DB, TB, ReturningCallbackRow<DB, TB, O, CB>>

Type Parameters

Parameters

Returns ReturningInterface<DB, TB, ReturningRow<DB, TB, O, SE>>

returningAll

Type Parameters

Parameters

Returns MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>

Type Parameters

Parameters

Returns MultiTableReturningInterface<DB, TB, ReturningAllRow<DB, T, O>>

Returns ReturningInterface<DB, TB, Selectable<DB[TB]>>

Settings

On This Page