Class PostgresEntityDatabaseAdapter<TFields>

Type Parameters

TFields

Hierarchy

default<TFields>
- PostgresEntityDatabaseAdapter

Index

Constructors

Methods

applyQueryModifiersToQuery applyQueryModifiersToQueryOrderByRaw deleteAsync deleteInternalAsync fetchManyByFieldEqualityConjunctionAsync fetchManyByFieldEqualityConjunctionInternalAsync fetchManyByRawWhereClauseAsync fetchManyByRawWhereClauseInternalAsync fetchManyWhereAsync fetchManyWhereInternalAsync getFieldTransformerMap insertAsync insertInternalAsync updateAsync updateInternalAsync

Constructors

constructor

new PostgresEntityDatabaseAdapter<TFields>(entityConfiguration): PostgresEntityDatabaseAdapter<TFields>
Type Parameters
- TFields
Parameters
- entityConfiguration: default<TFields>
Returns PostgresEntityDatabaseAdapter<TFields>
Inherited from EntityDatabaseAdapter<TFields>.constructor
- Defined in packages/entity/build/EntityDatabaseAdapter.d.ts:82

Methods

`Private` applyQueryModifiersToQuery

applyQueryModifiersToQuery(query, querySelectionModifiers): QueryBuilder<any, any>
Parameters
- query: QueryBuilder<any, any>
- querySelectionModifiers: TableQuerySelectionModifiers
Returns QueryBuilder<any, any>
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:70

`Private` applyQueryModifiersToQueryOrderByRaw

applyQueryModifiersToQueryOrderByRaw(query, querySelectionModifiers): QueryBuilder<any, any>
Parameters
- query: QueryBuilder<any, any>
- querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw
Returns QueryBuilder<any, any>
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:56

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/build/EntityDatabaseAdapter.d.ts:148

`Protected` deleteInternalAsync

deleteInternalAsync(queryInterface, tableName, tableIdField, id): Promise<number>
Parameters
- queryInterface: Knex<any, any[]>
- tableName: string
- tableIdField: string
- id: any
Returns Promise<number>
Overrides EntityDatabaseAdapter.deleteInternalAsync
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:178

fetchManyByFieldEqualityConjunctionAsync

fetchManyByFieldEqualityConjunctionAsync<N>(queryContext, fieldEqualityOperands, querySelectionModifiers): 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 packages/entity/build/EntityDatabaseAdapter.d.ts:108

`Protected` fetchManyByFieldEqualityConjunctionInternalAsync

fetchManyByFieldEqualityConjunctionInternalAsync(queryInterface, tableName, tableFieldSingleValueEqualityOperands, tableFieldMultiValueEqualityOperands, querySelectionModifiers): Promise<object[]>
Parameters
- queryInterface: Knex<any, any[]>
- tableName: string
- tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[]
- tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[]
- querySelectionModifiers: TableQuerySelectionModifiers
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.fetchManyByFieldEqualityConjunctionInternalAsync
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:95

fetchManyByRawWhereClauseAsync

fetchManyByRawWhereClauseAsync(queryContext, rawWhereClause, bindings, querySelectionModifiers): 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 packages/entity/build/EntityDatabaseAdapter.d.ts:119

`Protected` fetchManyByRawWhereClauseInternalAsync

fetchManyByRawWhereClauseInternalAsync(queryInterface, tableName, rawWhereClause, bindings, querySelectionModifiers): Promise<object[]>
Parameters
- queryInterface: Knex<any, any[]>
- tableName: string
- rawWhereClause: string
- bindings: object | any[]
- querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.fetchManyByRawWhereClauseInternalAsync
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:141

fetchManyWhereAsync

fetchManyWhereAsync<K>(queryContext, field, fieldValues): Promise<ReadonlyMap<NonNullable<TFields[K]>, readonly Readonly<TFields>[]>>
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<TFields[K]>[]
  
  fieldName field values being queried
Returns Promise<ReadonlyMap<NonNullable<TFields[K]>, readonly Readonly<TFields>[]>>
map from fieldValue to objects that match the query for that fieldValue
Inherited from EntityDatabaseAdapter.fetchManyWhereAsync
- Defined in packages/entity/build/EntityDatabaseAdapter.d.ts:97

`Protected` fetchManyWhereInternalAsync

fetchManyWhereInternalAsync(queryInterface, tableName, tableField, tableValues): Promise<object[]>
Parameters
- queryInterface: Knex<any, any[]>
- tableName: string
- tableField: string
- tableValues: readonly any[]
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.fetchManyWhereInternalAsync
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:42

`Protected` getFieldTransformerMap

getFieldTransformerMap(): FieldTransformerMap
Returns FieldTransformerMap
Overrides EntityDatabaseAdapter.getFieldTransformerMap
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:16

insertAsync

insertAsync(queryContext, object): 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 packages/entity/build/EntityDatabaseAdapter.d.ts:128

`Protected` insertInternalAsync

insertInternalAsync(queryInterface, tableName, object): Promise<object[]>
Parameters
- queryInterface: Knex<any, any[]>
- tableName: string
- object: object
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.insertInternalAsync
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:156

updateAsync

updateAsync<K>(queryContext, idField, id, object): 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 packages/entity/build/EntityDatabaseAdapter.d.ts:139

`Protected` updateInternalAsync

updateInternalAsync(queryInterface, tableName, tableIdField, id, object): Promise<object[]>
Parameters
- queryInterface: Knex<any, any[]>
- tableName: string
- tableIdField: string
- id: any
- object: object
Returns Promise<object[]>
Overrides EntityDatabaseAdapter.updateInternalAsync
- Defined in packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:166

Class PostgresEntityDatabaseAdapter<TFields>

Type Parameters

TFields

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

TFields

Parameters

entityConfiguration: default<TFields>

Returns PostgresEntityDatabaseAdapter<TFields>

Methods

Private applyQueryModifiersToQuery

Parameters

query: QueryBuilder<any, any>

querySelectionModifiers: TableQuerySelectionModifiers

Returns QueryBuilder<any, any>

Private applyQueryModifiersToQueryOrderByRaw

Parameters

query: QueryBuilder<any, any>

querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw

Returns QueryBuilder<any, any>

deleteAsync

Type Parameters

K extends string | number | symbol

Parameters

queryContext: EntityQueryContext

idField: K

id: any

Returns Promise<void>

Protected deleteInternalAsync

Parameters

queryInterface: Knex<any, any[]>

tableName: string

tableIdField: string

id: any

Returns Promise<number>

fetchManyByFieldEqualityConjunctionAsync

Type Parameters

N extends string | number | symbol

Parameters

queryContext: EntityQueryContext

fieldEqualityOperands: FieldEqualityCondition<TFields, N>[]

querySelectionModifiers: QuerySelectionModifiers<TFields>

Returns Promise<readonly Readonly<TFields>[]>

Protected fetchManyByFieldEqualityConjunctionInternalAsync

Parameters

queryInterface: Knex<any, any[]>

tableName: string

tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[]

tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[]

querySelectionModifiers: TableQuerySelectionModifiers

Returns Promise<object[]>

fetchManyByRawWhereClauseAsync

Parameters

queryContext: EntityQueryContext

rawWhereClause: string

bindings: object | any[]

querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>

Returns Promise<readonly Readonly<TFields>[]>

Protected fetchManyByRawWhereClauseInternalAsync

Parameters

queryInterface: Knex<any, any[]>

tableName: string

rawWhereClause: string

bindings: object | any[]

querySelectionModifiers: TableQuerySelectionModifiersWithOrderByRaw

Returns Promise<object[]>

fetchManyWhereAsync

Type Parameters

K extends string | number | symbol

Parameters

queryContext: EntityQueryContext

field: K

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

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

Protected fetchManyWhereInternalAsync

`Private` applyQueryModifiersToQuery

`Private` applyQueryModifiersToQueryOrderByRaw

`Protected` deleteInternalAsync

`Protected` fetchManyByFieldEqualityConjunctionInternalAsync

`Protected` fetchManyByRawWhereClauseInternalAsync

`Protected` fetchManyWhereInternalAsync

`Protected` getFieldTransformerMap

`Protected` insertInternalAsync

`Protected` updateInternalAsync