DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/functions/include.md
include
ts
function include<TContext>(query): IncludeWrapper<TContext>;Defined in: packages/db/src/query/builder/include-functions.ts:74
Includes a correlated subquery as a live child Collection on each parent row. Use toArray() or materialize() for inline values instead.
Type Parameters#
TContext#
TContext extends Context
Parameters#
query#
QueryBuilder<TContext>
Returns#
IncludeWrapper<TContext>
Example#
ts
select(({ p }) => ({
...p,
issues: include(
q.from({ i: issues }).where(({ i }) => eq(i.projectId, p.id)),
),
}))