Class EntityDatabaseAdapter<TFields, TIDField>`Abstract`

A database adapter is an interface by which entity objects can be fetched, inserted, updated, and deleted from a database. This base class handles all entity field transformation. Subclasses are responsible for implementing database-specific logic for a type of database.

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof TFields

Index

Constructors

constructor

new EntityDatabaseAdapter<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
): EntityDatabaseAdapter<TFields, TIDField>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
Returns EntityDatabaseAdapter<TFields, TIDField>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:32

Properties

`Protected` `Readonly`entityConfiguration

entityConfiguration: EntityConfiguration<TFields, TIDField>

`Protected` `Readonly`fieldTransformerMap

fieldTransformerMap: FieldTransformerMap

Methods

deleteAsync

deleteAsync<K extends string | number | symbol>(
    queryContext: EntityQueryContext,
    idField: K,
    id: any,
): Promise<void>
Delete an object by ID.
Type Parameters
- K extends string | number | symbol
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the deletion
- idField: K
  the field in the object that is the ID
- id: any
  the value of the ID field in the object
Returns Promise<void>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:262

`Protected` `Abstract`deleteInternalAsync

deleteInternalAsync(
    queryInterface: any,
    tableName: string,
    tableIdField: string,
    id: any,
): Promise<number>
Parameters
- queryInterface: any
- tableName: string
- tableIdField: string
- id: any
Returns Promise<number>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:282

fetchManyWhereAsync

fetchManyWhereAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    queryContext: EntityQueryContext,
    key: TLoadKey,
    values: readonly TLoadValue[],
): Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>
Fetch many objects where key is one of values.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the fetch
- key: TLoadKey
  load key being queried
- values: readonly TLoadValue[]
  load values being queried
Returns Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>
map from value to objects that match the query for that value
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:51

`Protected` `Abstract`fetchManyWhereInternalAsync

fetchManyWhereInternalAsync(
    queryInterface: any,
    tableName: string,
    tableColumns: readonly string[],
    tableTuples: (readonly any[])[],
): Promise<object[]>
Parameters
- queryInterface: any
- tableName: string
- tableColumns: readonly string[]
- tableTuples: (readonly any[])[]
Returns Promise<object[]>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:96

fetchOneWhereAsync

fetchOneWhereAsync<
    TLoadKey extends
        IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
>(
    queryContext: EntityQueryContext,
    key: TLoadKey,
    value: TLoadValue,
): Promise<Readonly<TFields> | null>
Fetch one objects where key is equal to value, null if no matching object exists. Returned object is not guaranteed to be deterministic. Most concrete implementations will implement this with a "first" or "limit 1" query.
Type Parameters
- TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>
- TSerializedLoadValue
- TLoadValue extends IEntityLoadValue<TSerializedLoadValue>
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the fetch
- key: TLoadKey
  load key being queried
- value: TLoadValue
Returns Promise<Readonly<TFields> | null>
object that matches the query for the value
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:113

`Protected` `Abstract`fetchOneWhereInternalAsync

fetchOneWhereInternalAsync(
    queryInterface: any,
    tableName: string,
    tableColumns: readonly string[],
    tableTuple: readonly any[],
): Promise<object | null>
Parameters
- queryInterface: any
- tableName: string
- tableColumns: readonly string[]
- tableTuple: readonly any[]
Returns Promise<object | null>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:143

`Protected` `Abstract`getFieldTransformerMap

getFieldTransformerMap(): FieldTransformerMap
Transformer definitions for field types. Used to modify values as they are read from or written to the database. Override in concrete subclasses to change transformation behavior. If a field type is not present in the map, then fields of that type will not be transformed.

Returns FieldTransformerMap
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:41

insertAsync

insertAsync(
queryContext: EntityQueryContext,
object: Readonly<Partial<TFields>>,
): Promise<Readonly<TFields>>
Insert an object.
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the insert
- object: Readonly<Partial<TFields>>
  the object to insert
Returns Promise<Readonly<TFields>>
the inserted object
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:157

`Protected` `Abstract`insertInternalAsync

insertInternalAsync(
    queryInterface: any,
    tableName: string,
    object: object,
): Promise<object[]>
Parameters
- queryInterface: any
- tableName: string
- object: object
Returns Promise<object[]>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:192

updateAsync

updateAsync<K extends string | number | symbol>(
    queryContext: EntityQueryContext,
    idField: K,
    id: any,
    object: Readonly<Partial<TFields>>,
): Promise<Readonly<TFields>>
Update an object.
Type Parameters
- K extends string | number | symbol
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the update
- idField: K
  the field in the object that is the ID
- id: any
  the value of the ID field in the object
- object: Readonly<Partial<TFields>>
  the object to update
Returns Promise<Readonly<TFields>>
the updated object
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:207

`Protected` `Abstract`updateInternalAsync

updateInternalAsync(
    queryInterface: any,
    tableName: string,
    tableIdField: string,
    id: any,
    object: object,
): Promise<object[]>
Parameters
- queryInterface: any
- tableName: string
- tableIdField: string
- id: any
- object: object
Returns Promise<object[]>
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:247

Class EntityDatabaseAdapter<TFields, TIDField>Abstract

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EntityDatabaseAdapter<TFields, TIDField>

Properties

Protected ReadonlyentityConfiguration

Protected ReadonlyfieldTransformerMap

Methods

deleteAsync

Type Parameters

Parameters

Returns Promise<void>

Protected AbstractdeleteInternalAsync

Parameters

Returns Promise<number>

fetchManyWhereAsync

Type Parameters

Parameters

Returns Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>

Protected AbstractfetchManyWhereInternalAsync

Parameters

Returns Promise<object[]>

fetchOneWhereAsync

Type Parameters

Parameters

Returns Promise<Readonly<TFields> | null>

Protected AbstractfetchOneWhereInternalAsync

Parameters

Returns Promise<object | null>

Protected AbstractgetFieldTransformerMap

Returns FieldTransformerMap

insertAsync

Parameters

Returns Promise<Readonly<TFields>>

Protected AbstractinsertInternalAsync

Parameters

Returns Promise<object[]>

updateAsync

Type Parameters

Parameters

Returns Promise<Readonly<TFields>>

Protected AbstractupdateInternalAsync

Parameters

Returns Promise<object[]>

Settings

On This Page

Class EntityDatabaseAdapter<TFields, TIDField>`Abstract`

`Protected` `Readonly`entityConfiguration

`Protected` `Readonly`fieldTransformerMap

`Protected` `Abstract`deleteInternalAsync

`Protected` `Abstract`fetchManyWhereInternalAsync

`Protected` `Abstract`fetchOneWhereInternalAsync

`Protected` `Abstract`getFieldTransformerMap

`Protected` `Abstract`insertInternalAsync

`Protected` `Abstract`updateInternalAsync