Class PostgresEntityDatabaseAdapter<TFields>

Type Parameters

  • TFields extends Record<string, any>

Hierarchy

  • default<TFields>
    • PostgresEntityDatabaseAdapter

Constructors

constructor

Methods

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

Constructors

constructor

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>

ProtecteddeleteInternalAsync

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

ProtectedfetchManyByFieldEqualityConjunctionInternalAsync

  • fetchManyByFieldEqualityConjunctionInternalAsync(queryInterface, tableName, tableFieldSingleValueEqualityOperands, tableFieldMultiValueEqualityOperands, querySelectionModifiers): Promise<object[]>

  • Parameters

    • queryInterface: Knex<any, any[]>
    • tableName: string
    • tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[]
    • tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[]
    • querySelectionModifiers: TableQuerySelectionModifiers

    Returns Promise<object[]>

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

ProtectedfetchManyByRawWhereClauseInternalAsync

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

fetchManyWhereAsync

  • fetchManyWhereAsync<K>(queryContext, fieldName, 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

    • fieldName: K

      object field being queried

    • 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

ProtectedfetchManyWhereInternalAsync

ProtectedgetFieldTransformerMap

  • 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

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

ProtectedinsertInternalAsync

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

ProtectedupdateInternalAsync

Settings

Member Visibility

On This Page

Constructors
Methods