Interface CreateQueryBuilderOptions<C, ET, CF>

Options for createQueryBuilder.

interface CreateQueryBuilderOptions<
    C extends BaseConfigMap,
    ET extends EntityToken<C>,
    CF = unknown,
> {
    entityClient: EntityClient<C, CF>;
    entityToken: ET;
    hashKeyToken: C["HashKey"] | C["ShardedKeys"];
    pageKeyMap?: string;
}

Type Parameters

C extends BaseConfigMap
Entity-manager config map.
ET extends EntityToken<C>
Entity token type.
CF = unknown
Values-first config literal type carried by EntityClient.

Index

Properties

entityClient entityToken hashKeyToken pageKeyMap?

Properties

entityClient

entityClient: EntityClient<C, CF>

EntityClient instance.

entityToken

entityToken: ET

Entity token for the query.

hashKeyToken

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

Hash key token (global or sharded).

`Optional`pageKeyMap

pageKeyMap?: string

Optional dehydrated page-key map string to resume paging.