Interface QueryBuilderOptions<C>

QueryBuilder constructor options.

interface QueryBuilderOptions<C extends BaseConfigMap> {
    entityClient: EntityClient;
    entityToken: Extract<keyof Exactify<C["EntityMap"]>>;
    hashKeyToken: C["HashKey"] | C["ShardedKeys"];
    pageKeyMap?: string;
    tableName: string;
}

Type Parameters

C extends BaseConfigMap

Hierarchy

BaseQueryBuilderOptions<C, EntityClient<C>>
- QueryBuilderOptions

Index

Properties

entityClient entityToken hashKeyToken pageKeyMap? tableName

Properties

entityClient

entityClient: EntityClient

EntityClient instance.

entityToken

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

Entity token.

hashKeyToken

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

Hash key token.

`Optional`pageKeyMap

pageKeyMap?: string

Dehydrated page key map.

tableName

tableName: string

Table name.