Class BaseQueryBuilder<CC, EntityClient, IndexParams, ET, ITS, CF, K>`Abstract`

Abstract base class supporting a fluent API for building a ShardQueryMap using a database client.

Type Parameters

CC extends BaseConfigMap
ConfigMap that defines an EntityManager configuration's EntityMap, key properties, and TranscodeRegistry. If omitted, defaults to BaseConfigMap.
EntityClient extends BaseEntityClient<CC>
BaseEntityClient derived class instance.
IndexParams
Database platform-specific, index-specific query parameters.
ET extends EntityToken<CC> = EntityToken<CC>
ITS extends string = string
CF = unknown
Optional values-first config literal type for page key narrowing.
K = unknown
Optional projection keys; narrows item shape when provided.

Index

Constructors

Properties

entityClient entityToken hashKeyToken indexParamsMap pageKeyMap?

Methods

build getShardQueryFunction query

Constructors

constructor

new BaseQueryBuilder<
    CC extends BaseConfigMap,
    EntityClient extends BaseEntityClient<CC, unknown>,
    IndexParams,
    ET extends string | number | symbol = EntityToken<CC>,
    ITS extends string = string,
    CF = unknown,
    K = unknown,
>(
    options: BaseQueryBuilderOptions<CC, EntityClient>,
): BaseQueryBuilder<CC, EntityClient, IndexParams, ET, ITS, CF, K>
BaseQueryBuilder constructor.
Type Parameters
- CC extends BaseConfigMap
  ConfigMap that defines an EntityManager configuration's EntityMap, key properties, and TranscodeRegistry. If omitted, defaults to BaseConfigMap.
- EntityClient extends BaseEntityClient<CC, unknown>
  BaseEntityClient derived class instance.
- IndexParams
  Database platform-specific, index-specific query parameters.
- ET extends string | number | symbol = EntityToken<CC>
- ITS extends string = string
- CF = unknown
  Optional values-first config literal type for page key narrowing.
- K = unknown
  Optional projection keys; narrows item shape when provided.
Parameters
- options: BaseQueryBuilderOptions<CC, EntityClient>
Returns BaseQueryBuilder<CC, EntityClient, IndexParams, ET, ITS, CF, K>
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:59

Properties

`Readonly`entityClient

entityClient: EntityClient

EntityClient instance.

`Readonly`entityToken

entityToken: Extract<keyof Exactify<CC["EntityMap"]>>

Entity token.

`Readonly`hashKeyToken

hashKeyToken: CC["HashKey"] | CC["ShardedKeys"]

Hash key token.

`Protected` `Readonly`indexParamsMap

indexParamsMap: Record<ITS, IndexParams> = ...

Maps indexToken values to database platform-specific query parameters.

`Optional` `Readonly`pageKeyMap

pageKeyMap?: string

Dehydrated page key map.

Methods

build

build(): ShardQueryMap<CC, ET, ITS, CF, K>
Builds a ShardQueryMap object.

Returns ShardQueryMap<CC, ET, ITS, CF, K>
- The ShardQueryMap object.
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:94

`Protected` `Abstract`getShardQueryFunction

getShardQueryFunction(indexToken: ITS): ShardQueryFunction<CC, ET, ITS, CF, K>
Protected
Build a shard query function for a specific index token.
Parameters
- indexToken: ITS
  Index token identifying which index to query.
Returns ShardQueryFunction<CC, ET, ITS, CF, K>
A ShardQueryFunction that queries a single shard for this index.
Remarks
Implementations are provider-specific (e.g., DynamoDB). The returned function must:
- Query exactly one shard (partition) per invocation using the provided hash key value.
- Respect pageKey and pageSize for pagination.
- Return pageKey: undefined when that shard is exhausted.
Entity Manager will orchestrate calling these functions across shards and indexes.
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:85

query

query(
options: QueryBuilderQueryOptions<CC, ET, CF>,
): Promise<QueryResult<CC, ET, ITS, K>>
Execute the built query across shards and indexes via EntityManager.query.
Parameters
- options: QueryBuilderQueryOptions<CC, ET, CF>
  Query options excluding entityToken, pageKeyMap, and shardQueryMap, which are supplied by the builder.
Returns Promise<QueryResult<CC, ET, ITS, K>>
The merged, de-duplicated, sorted query result, including a compact pageKeyMap token for the next page.

Remarks
This delegates orchestration to Entity Manager; provider-specific behavior lives in getShardQueryFunction.
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:110