Class StubDatabaseAdapter<T>

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

Hierarchy

EntityDatabaseAdapter<T>
- StubDatabaseAdapter

Constructors

constructor

new StubDatabaseAdapter<T>(entityConfiguration2, dataStore): StubDatabaseAdapter<T>
Type Parameters
- T
Parameters
- entityConfiguration2: EntityConfiguration<T>
- dataStore: Map<string, Readonly<{
  [key: string]: any;
  }>[]>
Returns StubDatabaseAdapter<T>
Overrides EntityDatabaseAdapter.constructor
- Defined in packages/entity/src/utils/testing/StubDatabaseAdapter.ts:20

Properties

`Private` `Readonly` dataStore

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

`Private` `Readonly` entityConfiguration2

entityConfiguration2: EntityConfiguration<T>

Methods

deleteAsync

deleteAsync<K>(queryContext, idField, id): 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 packages/entity/src/EntityDatabaseAdapter.ts:367

`Protected` deleteInternalAsync

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

fetchManyByFieldEqualityConjunctionAsync

fetchManyByFieldEqualityConjunctionAsync<N>(queryContext, fieldEqualityOperands, querySelectionModifiers): Promise<readonly Readonly<T>[]>
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<T, N>[]
  
  list of field equality where clause operand specifications
- querySelectionModifiers: QuerySelectionModifiers<T>
  
  limit, offset, orderBy, and orderByRaw for the query
Returns Promise<readonly Readonly<T>[]>
array of objects matching the query
Inherited from EntityDatabaseAdapter.fetchManyByFieldEqualityConjunctionAsync
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:183

`Protected` fetchManyByFieldEqualityConjunctionInternalAsync

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

fetchManyByRawWhereClauseAsync

fetchManyByRawWhereClauseAsync(queryContext, rawWhereClause, bindings, querySelectionModifiers): Promise<readonly Readonly<T>[]>
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<T>
  
  limit, offset, and orderBy for the query
Returns Promise<readonly Readonly<T>[]>
array of objects matching the query
Inherited from EntityDatabaseAdapter.fetchManyByRawWhereClauseAsync
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:234

`Protected` fetchManyByRawWhereClauseInternalAsync

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

fetchManyWhereAsync

fetchManyWhereAsync<K>(queryContext, field, fieldValues): Promise<ReadonlyMap<NonNullable<T[K]>, readonly Readonly<T>[]>>
Fetch many objects where fieldName is one of fieldValues.
Type Parameters
- K extends string | number | symbol
Parameters
- queryContext: EntityQueryContext
  
  query context with which to perform the fetch
- field: K
- fieldValues: readonly NonNullable<T[K]>[]
  
  fieldName field values being queried
Returns Promise<ReadonlyMap<NonNullable<T[K]>, readonly Readonly<T>[]>>
map from fieldValue to objects that match the query for that fieldValue
Inherited from EntityDatabaseAdapter.fetchManyWhereAsync
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:138

`Protected` fetchManyWhereInternalAsync

fetchManyWhereInternalAsync(_queryInterface, tableName, tableField, tableValues): Promise<object[]>
Parameters
- _queryInterface: any
- tableName: string
- tableField: string
- tableValues: readonly any[]
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.fetchManyWhereInternalAsync
- Defined in packages/entity/src/utils/testing/StubDatabaseAdapter.ts:46

`Private` generateRandomID

generateRandomID(): any
Returns any
- Defined in packages/entity/src/utils/testing/StubDatabaseAdapter.ts:159

`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 packages/entity/src/utils/testing/StubDatabaseAdapter.ts:42

getObjectCollectionForTable

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

insertAsync

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

`Protected` insertInternalAsync

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

updateAsync

updateAsync<K>(queryContext, idField, id, object): Promise<Readonly<T>>
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<T>>
  
  the object to update
Returns Promise<Readonly<T>>
the updated object
Inherited from EntityDatabaseAdapter.updateAsync
- Defined in packages/entity/src/EntityDatabaseAdapter.ts:315

`Protected` updateInternalAsync

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

`Static` `Private` compareByOrderBys

compareByOrderBys(orderBys, objectA, objectB): 0 | 1 | -1
Parameters
- orderBys: {
  columnName: string;
  order: OrderByOrdering;
  }[]
- objectA: {
  [key: string]: any;
  }
  - [key: string]: any
- objectB: {
  [key: string]: any;
  }
  - [key: string]: any
Returns 0 | 1 | -1
- Defined in packages/entity/src/utils/testing/StubDatabaseAdapter.ts:62

`Static` convertFieldObjectsToDataStore

convertFieldObjectsToDataStore<T>(entityConfiguration, dataStore): Map<string, Readonly<{
[key: string]: any;
}>[]>
Type Parameters
- T
Parameters
- entityConfiguration: EntityConfiguration<T>
- dataStore: Map<string, Readonly<T>[]>
Returns Map<string, Readonly<{
[key: string]: any;
}>[]>
- Defined in packages/entity/src/utils/testing/StubDatabaseAdapter.ts:27

Class StubDatabaseAdapter<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

Parameters

entityConfiguration2: EntityConfiguration<T>

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

Returns StubDatabaseAdapter<T>

Properties

Private Readonly dataStore

Private Readonly entityConfiguration2

Methods

deleteAsync

Type Parameters

K extends string | number | symbol

Parameters

queryContext: EntityQueryContext

idField: K

id: any

Returns Promise<void>

Protected deleteInternalAsync

Parameters

_queryInterface: any

tableName: string

tableIdField: string

id: any

Returns Promise<number>

fetchManyByFieldEqualityConjunctionAsync

Type Parameters

N extends string | number | symbol

Parameters

queryContext: EntityQueryContext

fieldEqualityOperands: FieldEqualityCondition<T, N>[]

querySelectionModifiers: QuerySelectionModifiers<T>

Returns Promise<readonly Readonly<T>[]>

Protected fetchManyByFieldEqualityConjunctionInternalAsync

Parameters

_queryInterface: any

tableName: string

tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[]

tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[]

querySelectionModifiers: TableQuerySelectionModifiers

Returns Promise<object[]>

fetchManyByRawWhereClauseAsync

Parameters

queryContext: EntityQueryContext

rawWhereClause: string

bindings: object | any[]

querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<T>

Returns Promise<readonly Readonly<T>[]>

Protected fetchManyByRawWhereClauseInternalAsync

Parameters

_queryInterface: any

_tableName: string

_rawWhereClause: string

_bindings: object | any[]

_querySelectionModifiers: TableQuerySelectionModifiers

Returns Promise<object[]>

fetchManyWhereAsync

Type Parameters

K extends string | number | symbol

Parameters

queryContext: EntityQueryContext

field: K

fieldValues: readonly NonNullable<T[K]>[]

Returns Promise<ReadonlyMap<NonNullable<T[K]>, readonly Readonly<T>[]>>

Protected fetchManyWhereInternalAsync

Parameters

_queryInterface: any

tableName: string

tableField: string

tableValues: readonly any[]

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

`Private` `Readonly` dataStore

`Private` `Readonly` entityConfiguration2

`Protected` deleteInternalAsync

`Protected` fetchManyByFieldEqualityConjunctionInternalAsync

`Protected` fetchManyByRawWhereClauseInternalAsync

`Protected` fetchManyWhereInternalAsync

`Private` generateRandomID

`Protected` getFieldTransformerMap

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

`Protected` insertInternalAsync

`Protected` updateInternalAsync

`Static` `Private` compareByOrderBys

orderBys: {
columnName: string;
order: OrderByOrdering;
}[]

objectA: {
[key: string]: any;
}

objectB: {
[key: string]: any;
}

`Static` convertFieldObjectsToDataStore

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