Skip to content
Source
Sign inSign up
TanStack/db
Open History to see the last commit

IncludesSubquery.md

190 lines3.1 KB

Class: IncludesSubquery

Defined in: packages/db/src/query/ir.ts:139

Extends

  • BaseExpression

Constructors

Constructor

new IncludesSubquery(
   query, 
   correlationField, 
   childCorrelationField, 
   fieldName, 
   parentFilters?, 
   parentProjection?, 
   materialization?, 
   scalarField?): IncludesSubquery;

Defined in: packages/db/src/query/ir.ts:141

Parameters

query

QueryIR

correlationField

PropRef

childCorrelationField

PropRef

fieldName

string

parentFilters?

Where[]

parentProjection?

PropRef<any>[]

materialization?

IncludesMaterialization = ...

scalarField?

string

Returns

IncludesSubquery

Overrides

BaseExpression.constructor

Properties

__returnType

readonly __returnType: any;

Defined in: packages/db/src/query/ir.ts:73

Internal

  • Type brand for TypeScript inference

Inherited from

BaseExpression.__returnType

childCorrelationField

childCorrelationField: PropRef;

Defined in: packages/db/src/query/ir.ts:144


correlationField

correlationField: PropRef;

Defined in: packages/db/src/query/ir.ts:143


fieldName

fieldName: string;

Defined in: packages/db/src/query/ir.ts:145


materialization

materialization: IncludesMaterialization;

Defined in: packages/db/src/query/ir.ts:148


parentFilters?

optional parentFilters: Where[];

Defined in: packages/db/src/query/ir.ts:146


parentProjection?

optional parentProjection: PropRef<any>[];

Defined in: packages/db/src/query/ir.ts:147


query

query: QueryIR;

Defined in: packages/db/src/query/ir.ts:142


scalarField?

optional scalarField: string;

Defined in: packages/db/src/query/ir.ts:149


type

type: "includesSubquery";

Defined in: packages/db/src/query/ir.ts:140

Overrides

BaseExpression.type