Remote / foldkit-remote-drizzle

ManyRelation

interface · packages/remote-drizzle/src/binding.ts:41

interface ManyRelation<Target extends AnyEntityBinding> {
  readonly kind: 'many'
  readonly entity: Target
  readonly foreignKey: AnyColumn
  readonly localKey: AnyColumn
  readonly orderBy?: readonly OrderTerm[] | undefined
  readonly where?: SQL | undefined
  readonly single?: boolean | undefined
}

The foreign key lives on the target table.

Members

ManyRelation.kind

property · packages/remote-drizzle/src/binding.ts:42

readonly kind: 'many'

ManyRelation.entity

property · packages/remote-drizzle/src/binding.ts:43

readonly entity: Target

ManyRelation.foreignKey

property · packages/remote-drizzle/src/binding.ts:44

readonly foreignKey: AnyColumn

ManyRelation.localKey

property · packages/remote-drizzle/src/binding.ts:45

readonly localKey: AnyColumn

ManyRelation.orderBy

property · packages/remote-drizzle/src/binding.ts:47

readonly orderBy?: readonly OrderTerm[] | undefined

Natural order of the loaded refs; defaults to the target id.

ManyRelation.where

property · packages/remote-drizzle/src/binding.ts:49

readonly where?: SQL | undefined

Appended to the child query, e.g. to exclude soft-deleted rows.

ManyRelation.single

property · packages/remote-drizzle/src/binding.ts:55

readonly single?: boolean | undefined

The owner sees one of these, not a list: the inverse side of a one-to-one, whose foreign key is unique. It reads as a ref, or null when no row points back, and cannot be windowed or counted.