Interface TableMapperSettings<DB, TB, KeyColumns, SelectedColumns, InsertReturnColumns, UpdateReturnColumns>

Settings governing table mapper behavior, excluding transformations.

Type Parameters

  • DB

    Interface whose fields are table names defining tables.

  • TB extends keyof DB & string

    Name of the table.

  • KeyColumns extends Readonly<SelectableColumnTuple<DB[TB]>> | Readonly<[]> = []

    Tuple of the names of the table's key columns. Defaults to [], indicating no key columns. Supports up to 4 columns.

  • SelectedColumns extends Readonly<SelectionColumn<DB, TB>[]> | ["*"] = ["*"]

    Columns to return from selection queries. Defaults to ['*'], returning all columns. May specify aliases.

  • InsertReturnColumns extends Readonly<SelectionColumn<DB, TB>[]> | ["*"] = Readonly<KeyColumns>

    Columns to return from the table on insert queries that return columns. ['*'] returns all columns; [] returns none. May specify aliases. Defaults to KeyColumns.

  • UpdateReturnColumns extends Readonly<SelectionColumn<DB, TB>[]> | ["*"] = []

    Columns to return from the table on update queries that return columns. ['*'] returns all columns; [] returns none and is the default. May specify aliases.

Hierarchy

  • TableMapperSettings

Properties

insertReturnColumns? keyColumns? selectedColumns? updateReturnColumns?

Properties

Optional insertReturnColumns

insertReturnColumns?: InsertReturnColumns

Columns to return from insert queries that return columns. ['*'] returns all columns; [] returns none. May specify aliases. Defaults to KeyColumns.

Optional keyColumns

keyColumns?: KeyColumns

Tuple of the columns that make up the table's key. Defaults to [], indicating that no columns are keys.

Optional selectedColumns

selectedColumns?: SelectedColumns

Columns to return from selection queries. Defaults to [*], selecting all columns. May contain aliases.

Optional updateReturnColumns

updateReturnColumns?: UpdateReturnColumns

Columns to return from update queries that return columns. ['*'] returns all columns; [] returns none and is the default. May specify aliases.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc