Class BaseQueryBuilder<C, EntityClient, IndexParams>`Abstract`

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

Type Parameters

C extends BaseConfigMap
ConfigMap that defines an EntityManager configuration's EntityMap, key properties, and TranscodeMap. If omitted, defaults to BaseConfigMap.
EntityClient extends BaseEntityClient<C>
BaseEntityClient derived class instance.
IndexParams
Database platform-specific, index-specific query parameters.

Index

Constructors

Properties

entityClient entityToken hashKeyToken indexParamsMap pageKeyMap?

Methods

build getShardQueryFunction query

Constructors

constructor

new BaseQueryBuilder<
    C extends BaseConfigMap,
    EntityClient extends BaseEntityClient<C>,
    IndexParams,
>(
    options: BaseQueryBuilderOptions<C, EntityClient>,
): BaseQueryBuilder<C, EntityClient, IndexParams>
BaseQueryBuilder constructor.
Type Parameters
- C extends BaseConfigMap
- EntityClient extends BaseEntityClient<C>
- IndexParams
Parameters
- options: BaseQueryBuilderOptions<C, EntityClient>
Returns BaseQueryBuilder<C, EntityClient, IndexParams>
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:49

Properties

`Readonly`entityClient

entityClient: EntityClient

EntityClient instance.

`Readonly`entityToken

entityToken: EntityToken<C>

Entity token.

`Readonly`hashKeyToken

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

Hash key token.

`Protected` `Readonly`indexParamsMap

indexParamsMap: Record<string, IndexParams> = {}

Maps indexToken values to database platform-specific query parameters.

`Optional` `Readonly`pageKeyMap

pageKeyMap?: string

Dehydrated page key map.

Methods

build

build(): ShardQueryMap<C>
Builds a ShardQueryMap object.

Returns ShardQueryMap<C>
- The ShardQueryMap object.
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:67

`Protected` `Abstract`getShardQueryFunction

getShardQueryFunction(indexToken: string): ShardQueryFunction<C>
Parameters
- indexToken: string
Returns ShardQueryFunction<C>
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:58

query

query(options: QueryBuilderQueryOptions<C>): Promise<QueryResult<C>>
Parameters
- options: QueryBuilderQueryOptions<C>
Returns Promise<QueryResult<C>>
- Defined in src/BaseQueryBuilder/BaseQueryBuilder.ts:73