Type Alias SerializedJoinQuery

Represents a serialized join query structure for database operations with multiple table relationships.

type SerializedJoinQuery = {
    dereference: boolean;
    grouped: boolean;
    joinConditions: Record<Alias, JoinCondition>;
    joins: Record<Alias, Query<DocumentData>>;
    leftToRight: Record<Alias, Alias[]>;
    root: RootTableDetails;
    type: "join";
}

Properties

dereference: boolean

Indicates whether references should be dereferenced during query execution.

grouped: boolean

Specifies if the results should be grouped by the root alias.

joinConditions: Record<Alias, JoinCondition>

A mapping of aliases to their join conditions.

A mapping of aliases to their corresponding queries for joined tables.

leftToRight: Record<Alias, Alias[]>

A mapping of aliases to their dependent aliases, defining the join order from left to right.

The root table configuration for the join operation.

type: "join"

Specifies that this is a join query type.