TanStack
DB v0v0
Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Menu
Getting Started
Guides
Collections
Frameworks
Community
API Reference

IncludesSubquery

Class: IncludesSubquery

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

Extends

  • BaseExpression

Constructors

Constructor

ts
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:178

Parameters

query

QueryIR

correlationField

PropRef

childCorrelationField

PropRef

fieldName

string

parentFilters?

Where[]

parentProjection?

PropRef<any>[]

materialization?

IncludesMaterialization = ...

scalarField?

string

Returns

IncludesSubquery

Overrides

ts
BaseExpression.constructor
BaseExpression.constructor

Properties

__returnType

ts
readonly __returnType: any;
readonly __returnType: any;

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

Internal

  • Type brand for TypeScript inference

Inherited from

ts
BaseExpression.__returnType
BaseExpression.__returnType

childCorrelationField

ts
childCorrelationField: PropRef;
childCorrelationField: PropRef;

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

correlationField

ts
correlationField: PropRef;
correlationField: PropRef;

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

fieldName

ts
fieldName: string;
fieldName: string;

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

materialization

ts
materialization: IncludesMaterialization;
materialization: IncludesMaterialization;

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

parentFilters?

ts
optional parentFilters: Where[];
optional parentFilters: Where[];

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

parentProjection?

ts
optional parentProjection: PropRef<any>[];
optional parentProjection: PropRef<any>[];

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

query

ts
query: QueryIR;
query: QueryIR;

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

scalarField?

ts
optional scalarField: string;
optional scalarField: string;

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

type

ts
type: "includesSubquery";
type: "includesSubquery";

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

Overrides

ts
BaseExpression.type
BaseExpression.type
Edit on GitHub
Home
© 2026 TanStack LLC