Interface RelatedEntityJoinFieldConfig

Configuration for joining additional fields from a related entity into the base view.

interface RelatedEntityJoinFieldConfig {
fields?: RelatedEntityJoinField[];
mode?: "extend" | "override" | "disable";
}

Index

Properties

Properties

`Optional`fields

fields?: RelatedEntityJoinField[]

Fields to join from the related entity. Ignored when mode is 'disable'.

`Optional`mode

mode?: "extend" | "override" | "disable"

Controls how this config interacts with default NameField behavior.

"extend": Include the default NameField PLUS the specified fields (default)
"override": ONLY include the specified fields, ignore NameField
"disable": Don't join ANY fields from this related entity