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:176

Extends

  • BaseExpression

Constructors

Constructor

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

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

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:82

Internal

  • Type brand for TypeScript inference

Inherited from

BaseExpression.__returnType

childCorrelationField

childCorrelationField: PropRef;

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


correlationField

correlationField: PropRef;

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


fieldName

fieldName: string;

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


materialization

materialization: IncludesMaterialization;

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


parentFilters?

optional parentFilters: Where[];

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


parentProjection?

optional parentProjection: PropRef<any>[];

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


query

query: QueryIR;

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


scalarField?

optional scalarField: string;

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


type

type: "includesSubquery";

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

Overrides

BaseExpression.type