IdentifiablePostgresPersistence<T extends IIdentifiable<K>, K>

Abstract persistence component that stores data in PostgreSQL and implements a number of CRUD operations over data items with unique ids.

Extends: PostgresPersistence

Description

The IdentifiablePostgresPersistence class allows you to create persistence components that store data in PostgreSQL databases and implement a number of CRUD operations over data items with unique ids.

Important points

  • The data items must implement the IIdentifiable interface.
  • In basic scenarios child classes shall only override the getPageByFilter, getListByFilter or deleteByFilter operations with a specific filter function.
  • All other operations can be used out of the box.
  • In complex scenarios child classes can implement additional operations by accessing self._collection and self._model properties.

Configuration parameters

  • collection: (optional) Postgres collection name

connection(s):

  • discovery_key: (optional) key to retrieve the connection from IDiscovery
  • host: host name or IP address
  • port: port number (default: 27017)
  • uri: resource URI or connection string with all parameters in it

credential(s):

  • store_key: (optional) key to retrieve the credentials from ICredentialStore
  • username: (optional) username
  • password: (optional) user’s password

options:

  • connect_timeout: (optional) number of milliseconds to wait before timing out when connecting a new client (default: 0)
  • idle_timeout: (optional) number of milliseconds a client must sit idle in the pool and not be checked out (default: 10000)
  • max_pool_size: (optional) maximum number of clients the pool can contain (default: 10)

References

  • *:logger:*:*:1.0 - (optional) ILogger components to pass log messages
  • *:discovery:*:*:1.0 - (optional) IDiscovery services
  • *:credential-store:*:*:1.0 - (optional) credential stores to resolve credentials (ICredentialStore)

Constructors

Creates a new instance of the persistence component.

public constructor(tableName: string)

  • tableName: string - (optional) a collection name.

Instance methods

convertFromPublicPartial

Converts the given object from the public partial format.

protected convertFromPublicPartial(value: any): any

  • value: any - the object to convert from the public partial format.
  • returns: any - the initial object.

create

Creates a data item.

public create(correlationId: string, item: T): Promise<T>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • item: any - item to be created.
  • returns: Promise<T> - created item

deleteById

Deletes a data item by it’s unique id.

public deleteById(correlationId: string, id: K): Promise<T>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • id: K - id of the item to be deleted
  • returns: Promise<T> - deleted item

deleteByIds

Deletes multiple data items by their unique ids.

public deleteByIds(correlationId: string, ids: K[]): Promise<void>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • ids: K[] - ids of data items to be deleted.

getListByIds

Gets a list of data items retrieved by given unique ids.

public getListByIds(correlationId: string, ids: K[]): Promise<T[]>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • ids: K[] - ids of data items to be retrieved
  • returns: Promise<T[]> - data list

getOneById

Gets a data item by its unique id.

public getOneById(correlationId: string, id: K): Promise<T>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • id: K - id of data item to be retrieved.
  • returns: Promise<T> - data item

set

Sets a data item. If the data item exists it updates it. Otherwise, it creates a new data item.

public set(correlationId: string, item: T): Promise<T>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • item: T - item to be set.
  • returns: Promise<T> - updated item

update

Updates a data item.

public update(correlationId: string, item: T): Promise<T>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • item: T - item to be updated.
  • returns: Promise<T> - updated item

updatePartially

Updates only a few selected fields in a data item.

updatePartially(correlationId: string, id: K, data: AnyValueMap): Promise<T>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • id: K - id of the data item to be updated.
  • data: AnyValueMap - map with fields to be updated.
  • returns: Promise<T> - updated item

Examples

class MyPostgresPersistence extends IdentifiablePostgresPersistence<MyData, string> {
    public constructor() {
        base("mydata", new MyDataPostgresSchema());
    }

    private composeFilter(filter: FilterParams): any {
        filter = filter || new FilterParams();
        let criteria = [];
        let name = filter.getAsNullableString('name');
        if (name != null)
            criteria.push({ name: name });
        return criteria.length > 0 ? { $and: criteria } : null;
    }

    public getPageByFilter(correlationId: string, filter: FilterParams,
        paging: PagingParams): Promise<DataPage<MyData>> {
        return base.getPageByFilter(correlationId, this.composeFilter(filter), paging, null, null);
    }
}

let persistence = new MyPostgresPersistence();
persistence.configure(ConfigParams.fromTuples(
    "host", "localhost",
    "port", 27017
));

await persitence.open("123");

let item = await persistence.create("123", { id: "1", name: "ABC" });
let page = await persistence.getPageByFilter(
  "123",
  FilterParams.fromTuples("name", "ABC"),
  null
);

console.log(page.data);          // Result: { id: "1", name: "ABC" }
await persistence.deleteById("123", "1");