Class StubDatabaseAdapter<TFields, TIDField>

Type Parameters

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

Hierarchy

EntityDatabaseAdapter<TFields, TIDField>
- StubDatabaseAdapter

Index

Constructors

Methods

deleteAsync deleteInternalAsync fetchManyByFieldEqualityConjunctionAsync fetchManyByFieldEqualityConjunctionInternalAsync fetchManyByRawWhereClauseAsync fetchManyByRawWhereClauseInternalAsync fetchManyWhereAsync fetchManyWhereInternalAsync getFieldTransformerMap getObjectCollectionForTable insertAsync insertInternalAsync updateAsync updateInternalAsync convertFieldObjectsToDataStore

Constructors

constructor

new StubDatabaseAdapter<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    entityConfiguration2: EntityConfiguration<TFields, TIDField>,
    dataStore: Map<string, Readonly<{ [key: string]: any }>[]>,
): StubDatabaseAdapter<TFields, TIDField>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- entityConfiguration2: EntityConfiguration<TFields, TIDField>
- dataStore: Map<string, Readonly<{ [key: string]: any }>[]>
Returns StubDatabaseAdapter<TFields, TIDField>
Overrides EntityDatabaseAdapter<TFields, TIDField>.constructor
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:23

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>
Inherited from EntityDatabaseAdapter.deleteAsync
- Defined in entity/build/src/EntityDatabaseAdapter.d.ts:166

`Protected`deleteInternalAsync

deleteInternalAsync(
    _queryInterface: any,
    tableName: string,
    tableIdField: string,
    id: any,
): Promise<number>
Parameters
- _queryInterface: any
- tableName: string
- tableIdField: string
- id: any
Returns Promise<number>
Overrides EntityDatabaseAdapter.deleteInternalAsync
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:250

fetchManyByFieldEqualityConjunctionAsync

fetchManyByFieldEqualityConjunctionAsync<N extends string | number | symbol>(
    queryContext: EntityQueryContext,
    fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
    querySelectionModifiers: QuerySelectionModifiers<TFields>,
): Promise<readonly Readonly<TFields>[]>
Fetch many objects matching the conjunction of where clauses constructed from specified field equality operands.
Type Parameters
- N extends string | number | symbol
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the fetch
- fieldEqualityOperands: FieldEqualityCondition<TFields, N>[]
  list of field equality where clause operand specifications
- querySelectionModifiers: QuerySelectionModifiers<TFields>
  limit, offset, orderBy, and orderByRaw for the query
Returns Promise<readonly Readonly<TFields>[]>
array of objects matching the query
Inherited from EntityDatabaseAdapter.fetchManyByFieldEqualityConjunctionAsync
- Defined in entity/build/src/EntityDatabaseAdapter.d.ts:126

`Protected`fetchManyByFieldEqualityConjunctionInternalAsync

fetchManyByFieldEqualityConjunctionInternalAsync(
    _queryInterface: any,
    tableName: string,
    tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[],
    tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[],
    querySelectionModifiers: TableQuerySelectionModifiers,
): Promise<object[]>
Parameters
- _queryInterface: any
- tableName: string
- tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[]
- tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[]
- querySelectionModifiers: TableQuerySelectionModifiers
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.fetchManyByFieldEqualityConjunctionInternalAsync
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:137

fetchManyByRawWhereClauseAsync

fetchManyByRawWhereClauseAsync(
    queryContext: EntityQueryContext,
    rawWhereClause: string,
    bindings: object | any[],
    querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>,
): Promise<readonly Readonly<TFields>[]>
Fetch many objects matching the raw WHERE clause.
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the fetch
- rawWhereClause: string
  parameterized SQL WHERE clause with positional binding placeholders or named binding placeholders
- bindings: object | any[]
  array of positional bindings or object of named bindings
- querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>
  limit, offset, and orderBy for the query
Returns Promise<readonly Readonly<TFields>[]>
array of objects matching the query
Inherited from EntityDatabaseAdapter.fetchManyByRawWhereClauseAsync
- Defined in entity/build/src/EntityDatabaseAdapter.d.ts:137

`Protected`fetchManyByRawWhereClauseInternalAsync

fetchManyByRawWhereClauseInternalAsync(
    _queryInterface: any,
    _tableName: string,
    _rawWhereClause: string,
    _bindings: object | any[],
    _querySelectionModifiers: TableQuerySelectionModifiers,
): Promise<object[]>
Parameters
- _queryInterface: any
- _tableName: string
- _rawWhereClause: string
- _bindings: object | any[]
- _querySelectionModifiers: TableQuerySelectionModifiers
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.fetchManyByRawWhereClauseInternalAsync
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:173

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
Inherited from EntityDatabaseAdapter.fetchManyWhereAsync
- Defined in entity/build/src/EntityDatabaseAdapter.d.ts:115

`Protected`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[]>
Overrides EntityDatabaseAdapter.fetchManyWhereInternalAsync
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:64

`Protected`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
Overrides EntityDatabaseAdapter.getFieldTransformerMap
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:48

getObjectCollectionForTable

getObjectCollectionForTable(tableName: string): { [key: string]: any }[]
Parameters
- tableName: string
Returns { [key: string]: any }[]
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:44

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
Inherited from EntityDatabaseAdapter.insertAsync
- Defined in entity/build/src/EntityDatabaseAdapter.d.ts:146

`Protected`insertInternalAsync

insertInternalAsync(
    _queryInterface: any,
    tableName: string,
    object: object,
): Promise<object[]>
Parameters
- _queryInterface: any
- tableName: string
- object: object
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.insertInternalAsync
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:200

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
Inherited from EntityDatabaseAdapter.updateAsync
- Defined in entity/build/src/EntityDatabaseAdapter.d.ts:157

`Protected`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[]>
Overrides EntityDatabaseAdapter.updateInternalAsync
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:219

`Static`convertFieldObjectsToDataStore

convertFieldObjectsToDataStore<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
    dataStore: Map<string, Readonly<TFields>[]>,
): Map<string, Readonly<{ [key: string]: any }>[]>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
- dataStore: Map<string, Readonly<TFields>[]>
Returns Map<string, Readonly<{ [key: string]: any }>[]>
- Defined in entity-testing-utils/src/StubDatabaseAdapter.ts:30

Class StubDatabaseAdapter<TFields, TIDField>

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StubDatabaseAdapter<TFields, TIDField>

Methods

deleteAsync

Type Parameters

Parameters

Returns Promise<void>

ProtecteddeleteInternalAsync

Parameters

Returns Promise<number>

fetchManyByFieldEqualityConjunctionAsync

Type Parameters

Parameters

Returns Promise<readonly Readonly<TFields>[]>

ProtectedfetchManyByFieldEqualityConjunctionInternalAsync

Parameters

Returns Promise<object[]>

fetchManyByRawWhereClauseAsync

Parameters

Returns Promise<readonly Readonly<TFields>[]>

ProtectedfetchManyByRawWhereClauseInternalAsync

Parameters

Returns Promise<object[]>

fetchManyWhereAsync

Type Parameters

Parameters

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

ProtectedfetchManyWhereInternalAsync

Parameters

Returns Promise<object[]>

ProtectedgetFieldTransformerMap

Returns FieldTransformerMap

getObjectCollectionForTable

Parameters

Returns { [key: string]: any }[]

insertAsync

Parameters

Returns Promise<Readonly<TFields>>

ProtectedinsertInternalAsync

Parameters

Returns Promise<object[]>

updateAsync

Type Parameters

Parameters

Returns Promise<Readonly<TFields>>

ProtectedupdateInternalAsync

Parameters

Returns Promise<object[]>

StaticconvertFieldObjectsToDataStore

Type Parameters

Parameters

Returns Map<string, Readonly<{ [key: string]: any }>[]>

Settings

On This Page

`Protected`deleteInternalAsync

`Protected`fetchManyByFieldEqualityConjunctionInternalAsync

`Protected`fetchManyByRawWhereClauseInternalAsync

`Protected`fetchManyWhereInternalAsync

`Protected`getFieldTransformerMap

`Protected`insertInternalAsync

`Protected`updateInternalAsync

`Static`convertFieldObjectsToDataStore