Skip to content

IncludesSubquery

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

Extends

  • BaseExpression

Constructors

Constructor

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

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

Parameters

query

QueryIR

correlationField

PropRef

childCorrelationField

PropRef

fieldName

string

runtime
createBucketFacades

(...args) => BucketFacadeAdapter = ...

materializeCompilation

(compilation, getRootKey?) => MaterializedRootCompilation

parentFilters?

Where[]

parentProjection?

PropRef<any>[]

materialization?

IncludesMaterialization = ...

scalarField?

string

Returns

IncludesSubquery

Overrides

ts
BaseExpression.constructor

Properties

__returnType

ts
readonly __returnType: any;

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

Internal

  • Type brand for TypeScript inference

Inherited from

ts
BaseExpression.__returnType

childCorrelationField

ts
childCorrelationField: PropRef;

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


correlationField

ts
correlationField: PropRef;

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


fieldName

ts
fieldName: string;

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


materialization

ts
materialization: IncludesMaterialization;

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


parentFilters?

ts
optional parentFilters: Where[];

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


parentProjection?

ts
optional parentProjection: PropRef<any>[];

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


query

ts
query: QueryIR;

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


runtime

ts
runtime: object;

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

createBucketFacades()

ts
createBucketFacades: (...args) => BucketFacadeAdapter;
Parameters
args

...[string, BucketFacadeCompilation[], (count) => void]

Returns

BucketFacadeAdapter

materializeCompilation()

ts
materializeCompilation: (compilation, getRootKey?) => MaterializedRootCompilation;

Compiles inline includes into the same D2 graph as their parent relation. Collection-valued includes become inert bucket references. The public facade adapter resolves those references after the graph reaches quiescence.

Parameters
compilation

CompilationResult

getRootKey?

(row) => unknown

Returns

MaterializedRootCompilation


scalarField?

ts
optional scalarField: string;

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


type

ts
type: "includesSubquery";

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

Overrides

ts
BaseExpression.type