IncludesSubquery | TanStack DB Docs

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

Extends

BaseExpression

Constructors

Constructor

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

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

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

Parameters

fieldName

string

parentFilters?

Where[]

parentProjection?

PropRef<any>[]

materialization?

IncludesMaterialization = ...

scalarField?

string

Returns

IncludesSubquery

Overrides

BaseExpression.constructor

BaseExpression.constructor

Properties

__returnType

readonly __returnType: any;

readonly __returnType: any;

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

Internal

Type brand for TypeScript inference

Inherited from

BaseExpression.__returnType

BaseExpression.__returnType

childCorrelationField

childCorrelationField: PropRef;

childCorrelationField: PropRef;

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

correlationField

correlationField: PropRef;

correlationField: PropRef;

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

fieldName

fieldName: string;

fieldName: string;

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

materialization

materialization: IncludesMaterialization;

materialization: IncludesMaterialization;

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

parentFilters?

optional parentFilters: Where[];

optional parentFilters: Where[];

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

parentProjection?

optional parentProjection: PropRef<any>[];

optional parentProjection: PropRef<any>[];

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

query

query: QueryIR;

query: QueryIR;

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

scalarField?

optional scalarField: string;

optional scalarField: string;

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

type

type: "includesSubquery";

type: "includesSubquery";

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

Overrides

BaseExpression.type

BaseExpression.type