@twin.org/entity-storage-connector-postgresql 0.0.3-next.2 → 0.0.3-next.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/README.md +7 -12
  2. package/dist/es/postgreSqlEntityStorageConnector.js +471 -92
  3. package/dist/es/postgreSqlEntityStorageConnector.js.map +1 -1
  4. package/dist/types/postgreSqlEntityStorageConnector.d.ts +67 -5
  5. package/docs/changelog.md +425 -46
  6. package/docs/examples.md +98 -1
  7. package/docs/reference/classes/PostgreSqlEntityStorageConnector.md +301 -21
  8. package/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConfig.md +7 -7
  9. package/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConstructorOptions.md +6 -6
  10. package/locales/en.json +17 -2
  11. package/package.json +6 -6
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- # TWIN Entity Storage Connector PostgreSql
1
+ # Entity Storage Connector PostgreSQL
2
2
 
3
- Entity Storage connector implementation using PostgreSql storage.
3
+ This package provides a PostgreSQL backend for relational persistence, transactions and advanced SQL features. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.
4
4
 
5
5
  ## Installation
6
6
 
@@ -8,18 +8,13 @@ Entity Storage connector implementation using PostgreSql storage.
8
8
  npm install @twin.org/entity-storage-connector-postgresql
9
9
  ```
10
10
 
11
- ## Testing
11
+ ## Docker
12
12
 
13
- The tests developed are functional tests and need an instance of PostgreSql up and running. To run PostgreSql locally:
13
+ To perform testing of this component it may be necessary to launch a local instance to communicate with.
14
14
 
15
- ```sh
16
- docker run -p 5444:5432 --name twin-entity-storage-postgresql --hostname postgres -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -d postgres
17
- ```
18
-
19
- Afterwards you can run the tests as follows:
20
-
21
- ```sh
22
- npm run test
15
+ ```shell
16
+ docker pull postgres:latest
17
+ docker run -d --name twin-entity-storage-postgresql -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=password -p 5444:5432 postgres:latest
23
18
  ```
24
19
 
25
20
  ## Examples