MergeContextForJoinCallback

Type Alias: MergeContextForJoinCallback<TContext, TNewSchema>

ts
type MergeContextForJoinCallback<TContext, TNewSchema> = object;

Defined in: packages/db/src/query/builder/types.ts:821

MergeContextForJoinCallback - Special context for join condition callbacks

This type creates a context specifically for the onCallback parameter of join operations. The key difference from MergeContextWithJoinType is that NO optionality is applied here.

Why No Optionality? In SQL, join conditions are evaluated BEFORE optionality is determined. Both tables must be treated as available (non-optional) within the join condition itself. Optionality is only applied to the result AFTER the join logic executes.

Example:

typescript
.from({ users })
.leftJoin({ orders }, ({ users, orders }) => {
  // users is NOT optional here - we can access users.id directly
  // orders is NOT optional here - we can access orders.userId directly
  return eq(users.id, orders.userId)
})
.where(({ orders }) => {
  // NOW orders is optional because it's after the LEFT JOIN
  return orders?.status === 'pending'
})

The simple intersection (&) merges schemas without any optionality transformation.

Type Parameters

TContext

TContext extends Context

TNewSchema

TNewSchema extends ContextSchema

Properties

baseSchema

ts
baseSchema: TContext["baseSchema"];

Defined in: packages/db/src/query/builder/types.ts:825


fromSourceName

ts
fromSourceName: TContext["fromSourceName"];

Defined in: packages/db/src/query/builder/types.ts:828


hasJoins

ts
hasJoins: true;

Defined in: packages/db/src/query/builder/types.ts:829


joinTypes

ts
joinTypes: TContext["joinTypes"] extends Record<string, any> ? TContext["joinTypes"] : object;

Defined in: packages/db/src/query/builder/types.ts:830


result

ts
result: TContext["result"];

Defined in: packages/db/src/query/builder/types.ts:833


schema

ts
schema: TContext["schema"] & TNewSchema;

Defined in: packages/db/src/query/builder/types.ts:827