Class PostgresEntityDatabaseAdapter<TFields, TIDField>

Type Parameters

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

Hierarchy (View Summary)

BasePostgresEntityDatabaseAdapter<TFields, TIDField>
- PostgresEntityDatabaseAdapter

Constructors

constructor

new PostgresEntityDatabaseAdapter<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    entityConfiguration: EntityConfiguration<TFields, TIDField>,
    adapterConfiguration?: PostgresEntityDatabaseAdapterConfiguration,
): PostgresEntityDatabaseAdapter<TFields, TIDField>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
- adapterConfiguration: PostgresEntityDatabaseAdapterConfiguration = {}
Returns PostgresEntityDatabaseAdapter<TFields, TIDField>
Overrides BasePostgresEntityDatabaseAdapter.constructor
- Defined in entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:21

Properties

`Protected` `Readonly`entityConfiguration

entityConfiguration: EntityConfiguration<TFields, TIDField>

`Protected` `Readonly`fieldTransformerMap

fieldTransformerMap: FieldTransformerMap

Accessors

paginationMaxPageSize

get paginationMaxPageSize(): number | undefined
Get the maximum page size for pagination.

Returns number | undefined
maximum page size if configured, undefined otherwise
Overrides BasePostgresEntityDatabaseAdapter.paginationMaxPageSize
- Defined in entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:28

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

`Protected`deleteInternalAsync

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

fetchManyByFieldEqualityConjunctionAsync

fetchManyByFieldEqualityConjunctionAsync<N extends string | number | symbol>(
    queryContext: EntityQueryContext,
    fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
    querySelectionModifiers: PostgresQuerySelectionModifiers<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: PostgresQuerySelectionModifiers<TFields>
  limit, offset, orderBy, and orderByRaw for the query
Returns Promise<readonly Readonly<TFields>[]>
array of objects matching the query
Inherited from BasePostgresEntityDatabaseAdapter.fetchManyByFieldEqualityConjunctionAsync
- Defined in entity-database-adapter-knex/src/BasePostgresEntityDatabaseAdapter.ts:168

`Protected`fetchManyByFieldEqualityConjunctionInternalAsync

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

fetchManyByRawWhereClauseAsync

fetchManyByRawWhereClauseAsync(
    queryContext: EntityQueryContext,
    rawWhereClause: string,
    bindings: object | any[],
    querySelectionModifiers: PostgresQuerySelectionModifiersWithOrderByRaw<
        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: PostgresQuerySelectionModifiersWithOrderByRaw<TFields>
  limit, offset, and orderBy for the query
Returns Promise<readonly Readonly<TFields>[]>
array of objects matching the query
Inherited from BasePostgresEntityDatabaseAdapter.fetchManyByRawWhereClauseAsync
- Defined in entity-database-adapter-knex/src/BasePostgresEntityDatabaseAdapter.ts:219

`Protected`fetchManyByRawWhereClauseInternalAsync

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

fetchManyBySQLFragmentAsync

fetchManyBySQLFragmentAsync(
    queryContext: EntityQueryContext,
    sqlFragment: SQLFragment,
    querySelectionModifiers: PostgresQuerySelectionModifiersWithOrderByFragment<
        TFields,
    >,
): Promise<readonly Readonly<TFields>[]>
Fetch many objects matching the SQL fragment.
Parameters
- queryContext: EntityQueryContext
  query context with which to perform the fetch
- sqlFragment: SQLFragment
  SQLFragment for the WHERE clause of the query
- querySelectionModifiers: PostgresQuerySelectionModifiersWithOrderByFragment<TFields>
  limit, offset, and orderByFragment for the query
Returns Promise<readonly Readonly<TFields>[]>
array of objects matching the query
Inherited from BasePostgresEntityDatabaseAdapter.fetchManyBySQLFragmentAsync
- Defined in entity-database-adapter-knex/src/BasePostgresEntityDatabaseAdapter.ts:254

`Protected`fetchManyBySQLFragmentInternalAsync

fetchManyBySQLFragmentInternalAsync(
    queryInterface: Knex,
    tableName: string,
    sqlFragment: SQLFragment,
    querySelectionModifiers: TableQuerySelectionModifiersWithOrderByFragment,
): Promise<object[]>
Parameters
- queryInterface: Knex
- tableName: string
- sqlFragment: SQLFragment
- querySelectionModifiers: TableQuerySelectionModifiersWithOrderByFragment
Returns Promise<object[]>
Overrides BasePostgresEntityDatabaseAdapter.fetchManyBySQLFragmentInternalAsync
- Defined in entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:223

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

`Protected`fetchManyWhereInternalAsync

fetchManyWhereInternalAsync(
    queryInterface: Knex,
    tableName: string,
    tableColumns: readonly string[],
    tableTuples: any[][],
): Promise<object[]>
Parameters
- queryInterface: Knex
- tableName: string
- tableColumns: readonly string[]
- tableTuples: any[][]
Returns Promise<object[]>
Overrides BasePostgresEntityDatabaseAdapter.fetchManyWhereInternalAsync
- Defined in entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:58

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

`Protected`fetchOneWhereInternalAsync

fetchOneWhereInternalAsync(
    queryInterface: Knex,
    tableName: string,
    tableColumns: readonly string[],
    tableTuple: readonly any[],
): Promise<object | null>
Parameters
- queryInterface: Knex
- tableName: string
- tableColumns: readonly string[]
- tableTuple: readonly any[]
Returns Promise<object | null>
Overrides BasePostgresEntityDatabaseAdapter.fetchOneWhereInternalAsync
- Defined in entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:102

`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 BasePostgresEntityDatabaseAdapter.getFieldTransformerMap
- Defined in entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts:32

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

`Protected`insertInternalAsync

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

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

`Protected`updateInternalAsync

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

Class PostgresEntityDatabaseAdapter<TFields, TIDField>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PostgresEntityDatabaseAdapter<TFields, TIDField>

Properties

Protected ReadonlyentityConfiguration

Protected ReadonlyfieldTransformerMap

Accessors

paginationMaxPageSize

Returns number | undefined

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[]>

fetchManyBySQLFragmentAsync

Parameters

Returns Promise<readonly Readonly<TFields>[]>

ProtectedfetchManyBySQLFragmentInternalAsync

Parameters

Returns Promise<object[]>

fetchManyWhereAsync

Type Parameters

Parameters

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

ProtectedfetchManyWhereInternalAsync

Parameters

Returns Promise<object[]>

fetchOneWhereAsync

Type Parameters

Parameters

Returns Promise<Readonly<TFields> | null>

ProtectedfetchOneWhereInternalAsync

Parameters

Returns Promise<object | null>

ProtectedgetFieldTransformerMap

Returns FieldTransformerMap

insertAsync

Parameters

Returns Promise<Readonly<TFields>>

ProtectedinsertInternalAsync

Parameters

Returns Promise<object[]>

updateAsync

Type Parameters

Parameters

Returns Promise<Readonly<TFields>>

ProtectedupdateInternalAsync

Parameters

Returns Promise<object[]>

Settings

On This Page

`Protected` `Readonly`entityConfiguration

`Protected` `Readonly`fieldTransformerMap

`Protected`deleteInternalAsync

`Protected`fetchManyByFieldEqualityConjunctionInternalAsync

`Protected`fetchManyByRawWhereClauseInternalAsync

`Protected`fetchManyBySQLFragmentInternalAsync

`Protected`fetchManyWhereInternalAsync

`Protected`fetchOneWhereInternalAsync

`Protected`getFieldTransformerMap

`Protected`insertInternalAsync

`Protected`updateInternalAsync