@twin.org/entity-storage-connector-postgresql 0.0.3-next.1 → 0.0.3-next.10

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 +326 -54
  3. package/dist/es/postgreSqlEntityStorageConnector.js.map +1 -1
  4. package/dist/types/postgreSqlEntityStorageConnector.d.ts +37 -3
  5. package/docs/changelog.md +188 -44
  6. package/docs/examples.md +98 -1
  7. package/docs/reference/classes/PostgreSqlEntityStorageConnector.md +149 -13
  8. package/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConfig.md +7 -7
  9. package/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConstructorOptions.md +6 -6
  10. package/locales/en.json +15 -2
  11. package/package.json +6 -6
package/docs/changelog.md CHANGED
@@ -1,24 +1,168 @@
1
- # @twin.org/entity-storage-connector-postgresql - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.0...entity-storage-connector-postgresql-v0.0.3-next.1) (2025-11-10)
3
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.9...entity-storage-connector-postgresql-v0.0.3-next.10) (2026-05-07)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * add context id features ([#55](https://github.com/twinfoundation/entity-storage/issues/55)) ([99c15a2](https://github.com/twinfoundation/entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
9
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
10
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
11
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
12
- * logging naming consistency ([f99d12d](https://github.com/twinfoundation/entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
13
- * synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
14
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
15
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
16
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
8
+ * entity storage enhancements ([#86](https://github.com/iotaledger/twin-entity-storage/issues/86)) ([1279af4](https://github.com/iotaledger/twin-entity-storage/commit/1279af42615c6497bb06539842cee44842dd1f75))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.9 to 0.0.3-next.10
16
+ * devDependencies
17
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.9 to 0.0.3-next.10
18
+
19
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.8...entity-storage-connector-postgresql-v0.0.3-next.9) (2026-04-22)
20
+
21
+
22
+ ### Bug Fixes
23
+
24
+ * adding integers types handler ([#82](https://github.com/iotaledger/twin-entity-storage/issues/82)) ([2704717](https://github.com/iotaledger/twin-entity-storage/commit/2704717fde7c0c8b39e8036b4d2a61654b51f917))
25
+
26
+
27
+ ### Dependencies
28
+
29
+ * The following workspace dependencies were updated
30
+ * dependencies
31
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
32
+ * devDependencies
33
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.8 to 0.0.3-next.9
34
+
35
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.7...entity-storage-connector-postgresql-v0.0.3-next.8) (2026-03-20)
36
+
37
+
38
+ ### Bug Fixes
39
+
40
+ * tests and fixes for the comparisons for null and undefined ([#79](https://github.com/iotaledger/twin-entity-storage/issues/79)) ([e7ffd62](https://github.com/iotaledger/twin-entity-storage/commit/e7ffd62e9ec40ef31498e6e2350bb25d9c84638a))
41
+
42
+
43
+ ### Dependencies
44
+
45
+ * The following workspace dependencies were updated
46
+ * dependencies
47
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
48
+ * devDependencies
49
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.7 to 0.0.3-next.8
50
+
51
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.6...entity-storage-connector-postgresql-v0.0.3-next.7) (2026-03-13)
52
+
53
+
54
+ ### Bug Fixes
55
+
56
+ * adding tests and fixes for dot notation ([#76](https://github.com/iotaledger/twin-entity-storage/issues/76)) ([3879337](https://github.com/iotaledger/twin-entity-storage/commit/387933797e33543e4d8b2d49b8beeb792512a4ff))
57
+
58
+
59
+ ### Dependencies
60
+
61
+ * The following workspace dependencies were updated
62
+ * dependencies
63
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
64
+ * devDependencies
65
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.6 to 0.0.3-next.7
66
+
67
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.5...entity-storage-connector-postgresql-v0.0.3-next.6) (2026-01-21)
68
+
69
+
70
+ ### Bug Fixes
71
+
72
+ * adding tests and support when neccesary for string include operator when needed ([#72](https://github.com/iotaledger/twin-entity-storage/issues/72)) ([3c723dd](https://github.com/iotaledger/twin-entity-storage/commit/3c723dd5694814398099d9d4594089dc6c66ba97))
73
+
74
+
75
+ ### Dependencies
76
+
77
+ * The following workspace dependencies were updated
78
+ * dependencies
79
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
80
+ * devDependencies
81
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.5 to 0.0.3-next.6
82
+
83
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.4...entity-storage-connector-postgresql-v0.0.3-next.5) (2026-01-06)
84
+
85
+
86
+ ### Miscellaneous Chores
87
+
88
+ * **entity-storage-connector-postgresql:** Synchronize repo versions
89
+
90
+
91
+ ### Dependencies
92
+
93
+ * The following workspace dependencies were updated
94
+ * dependencies
95
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
96
+ * devDependencies
97
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.4 to 0.0.3-next.5
98
+
99
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.3...entity-storage-connector-postgresql-v0.0.3-next.4) (2025-12-03)
100
+
101
+
102
+ ### Miscellaneous Chores
103
+
104
+ * **entity-storage-connector-postgresql:** Synchronize repo versions
105
+
106
+
107
+ ### Dependencies
108
+
109
+ * The following workspace dependencies were updated
110
+ * dependencies
111
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
112
+ * devDependencies
113
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.3 to 0.0.3-next.4
114
+
115
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.2...entity-storage-connector-postgresql-v0.0.3-next.3) (2025-11-26)
116
+
117
+
118
+ ### Features
119
+
120
+ * add support for object comparison conditions ([eb505a1](https://github.com/iotaledger/twin-entity-storage/commit/eb505a17a3642e95c4e3cf137a77a0a8fb388c97))
121
+
122
+
123
+ ### Dependencies
124
+
125
+ * The following workspace dependencies were updated
126
+ * dependencies
127
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
128
+ * devDependencies
129
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.2 to 0.0.3-next.3
130
+
131
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.1...entity-storage-connector-postgresql-v0.0.3-next.2) (2025-11-13)
132
+
133
+
134
+ ### Bug Fixes
135
+
136
+ * adding tests for debugging and patching the missing quotes and parse error handeling ([#61](https://github.com/iotaledger/twin-entity-storage/issues/61)) ([f746be5](https://github.com/iotaledger/twin-entity-storage/commit/f746be530799bede1db08482cf65fe780c5e75a0))
137
+
138
+
139
+ ### Dependencies
140
+
141
+ * The following workspace dependencies were updated
142
+ * dependencies
143
+ * @twin.org/entity-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
144
+ * devDependencies
145
+ * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.1 to 0.0.3-next.2
146
+
147
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.3-next.0...entity-storage-connector-postgresql-v0.0.3-next.1) (2025-11-10)
148
+
149
+
150
+ ### Features
151
+
152
+ * add context id features ([#55](https://github.com/iotaledger/twin-entity-storage/issues/55)) ([99c15a2](https://github.com/iotaledger/twin-entity-storage/commit/99c15a257539b61d9da63649ce573ebf47699fc9))
153
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
154
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
155
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
156
+ * logging naming consistency ([f99d12d](https://github.com/iotaledger/twin-entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
157
+ * synchronised storage ([#44](https://github.com/iotaledger/twin-entity-storage/issues/44)) ([94e10e2](https://github.com/iotaledger/twin-entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
158
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
159
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
160
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
17
161
 
18
162
 
19
163
  ### Bug Fixes
20
164
 
21
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
165
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
22
166
 
23
167
 
24
168
  ### Dependencies
@@ -29,12 +173,12 @@
29
173
  * devDependencies
30
174
  * @twin.org/entity-storage-connector-memory bumped from 0.0.3-next.0 to 0.0.3-next.1
31
175
 
32
- ## [0.0.2-next.10](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.9...entity-storage-connector-postgresql-v0.0.2-next.10) (2025-10-09)
176
+ ## [0.0.2-next.10](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.9...entity-storage-connector-postgresql-v0.0.2-next.10) (2025-10-09)
33
177
 
34
178
 
35
179
  ### Features
36
180
 
37
- * add validate-locales ([e66ef0d](https://github.com/twinfoundation/entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
181
+ * add validate-locales ([e66ef0d](https://github.com/iotaledger/twin-entity-storage/commit/e66ef0de26ca2f82b3fe89bb5c7a15a0978a9644))
38
182
 
39
183
 
40
184
  ### Dependencies
@@ -45,7 +189,7 @@
45
189
  * devDependencies
46
190
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.9 to 0.0.2-next.10
47
191
 
48
- ## [0.0.2-next.9](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.8...entity-storage-connector-postgresql-v0.0.2-next.9) (2025-10-02)
192
+ ## [0.0.2-next.9](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.8...entity-storage-connector-postgresql-v0.0.2-next.9) (2025-10-02)
49
193
 
50
194
 
51
195
  ### Miscellaneous Chores
@@ -61,12 +205,12 @@
61
205
  * devDependencies
62
206
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.8 to 0.0.2-next.9
63
207
 
64
- ## [0.0.2-next.8](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.7...entity-storage-connector-postgresql-v0.0.2-next.8) (2025-08-29)
208
+ ## [0.0.2-next.8](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.7...entity-storage-connector-postgresql-v0.0.2-next.8) (2025-08-29)
65
209
 
66
210
 
67
211
  ### Features
68
212
 
69
- * eslint migration to flat config ([f033b64](https://github.com/twinfoundation/entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
213
+ * eslint migration to flat config ([f033b64](https://github.com/iotaledger/twin-entity-storage/commit/f033b64984c0e6a8129d929c9dd816dcc1b8dab0))
70
214
 
71
215
 
72
216
  ### Dependencies
@@ -77,12 +221,12 @@
77
221
  * devDependencies
78
222
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.7 to 0.0.2-next.8
79
223
 
80
- ## [0.0.2-next.7](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.6...entity-storage-connector-postgresql-v0.0.2-next.7) (2025-08-20)
224
+ ## [0.0.2-next.7](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.6...entity-storage-connector-postgresql-v0.0.2-next.7) (2025-08-20)
81
225
 
82
226
 
83
227
  ### Features
84
228
 
85
- * logging naming consistency ([f99d12d](https://github.com/twinfoundation/entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
229
+ * logging naming consistency ([f99d12d](https://github.com/iotaledger/twin-entity-storage/commit/f99d12dea04b6d4f2b5632ff5473e9ec7d5f9055))
86
230
 
87
231
 
88
232
  ### Dependencies
@@ -93,12 +237,12 @@
93
237
  * devDependencies
94
238
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.6 to 0.0.2-next.7
95
239
 
96
- ## [0.0.2-next.6](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.5...entity-storage-connector-postgresql-v0.0.2-next.6) (2025-08-19)
240
+ ## [0.0.2-next.6](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.5...entity-storage-connector-postgresql-v0.0.2-next.6) (2025-08-19)
97
241
 
98
242
 
99
243
  ### Features
100
244
 
101
- * update framework core ([b59a380](https://github.com/twinfoundation/entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
245
+ * update framework core ([b59a380](https://github.com/iotaledger/twin-entity-storage/commit/b59a380bb7fba2b43610f69074dcdee24a4737da))
102
246
 
103
247
 
104
248
  ### Dependencies
@@ -109,7 +253,7 @@
109
253
  * devDependencies
110
254
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.5 to 0.0.2-next.6
111
255
 
112
- ## [0.0.2-next.5](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.4...entity-storage-connector-postgresql-v0.0.2-next.5) (2025-08-11)
256
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.4...entity-storage-connector-postgresql-v0.0.2-next.5) (2025-08-11)
113
257
 
114
258
 
115
259
  ### Miscellaneous Chores
@@ -125,7 +269,7 @@
125
269
  * devDependencies
126
270
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.4 to 0.0.2-next.5
127
271
 
128
- ## [0.0.2-next.4](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.3...entity-storage-connector-postgresql-v0.0.2-next.4) (2025-08-08)
272
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.3...entity-storage-connector-postgresql-v0.0.2-next.4) (2025-08-08)
129
273
 
130
274
 
131
275
  ### Miscellaneous Chores
@@ -141,7 +285,7 @@
141
285
  * devDependencies
142
286
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.3 to 0.0.2-next.4
143
287
 
144
- ## [0.0.2-next.3](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.2...entity-storage-connector-postgresql-v0.0.2-next.3) (2025-07-25)
288
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.2...entity-storage-connector-postgresql-v0.0.2-next.3) (2025-07-25)
145
289
 
146
290
 
147
291
  ### Miscellaneous Chores
@@ -157,12 +301,12 @@
157
301
  * devDependencies
158
302
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.2 to 0.0.2-next.3
159
303
 
160
- ## [0.0.2-next.2](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.1...entity-storage-connector-postgresql-v0.0.2-next.2) (2025-07-24)
304
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.1...entity-storage-connector-postgresql-v0.0.2-next.2) (2025-07-24)
161
305
 
162
306
 
163
307
  ### Features
164
308
 
165
- * synchronised storage ([#44](https://github.com/twinfoundation/entity-storage/issues/44)) ([94e10e2](https://github.com/twinfoundation/entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
309
+ * synchronised storage ([#44](https://github.com/iotaledger/twin-entity-storage/issues/44)) ([94e10e2](https://github.com/iotaledger/twin-entity-storage/commit/94e10e26d1feec801449dc04af7a9757ac7495ff))
166
310
 
167
311
 
168
312
  ### Dependencies
@@ -173,19 +317,19 @@
173
317
  * devDependencies
174
318
  * @twin.org/entity-storage-connector-memory bumped from 0.0.2-next.1 to 0.0.2-next.2
175
319
 
176
- ## [0.0.2-next.1](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.0...entity-storage-connector-postgresql-v0.0.2-next.1) (2025-07-17)
320
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.2-next.0...entity-storage-connector-postgresql-v0.0.2-next.1) (2025-07-17)
177
321
 
178
322
 
179
323
  ### Features
180
324
 
181
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
182
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
183
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
325
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
326
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
327
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
184
328
 
185
329
 
186
330
  ### Bug Fixes
187
331
 
188
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
332
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
189
333
 
190
334
 
191
335
  ### Dependencies
@@ -201,15 +345,15 @@
201
345
 
202
346
  ### Features
203
347
 
204
- * add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
205
- * release to production ([a309051](https://github.com/twinfoundation/entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
206
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
207
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
348
+ * add production release automation ([1eb4c8e](https://github.com/iotaledger/twin-entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
349
+ * release to production ([a309051](https://github.com/iotaledger/twin-entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
350
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
351
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
208
352
 
209
353
 
210
354
  ### Bug Fixes
211
355
 
212
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
356
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
213
357
 
214
358
 
215
359
  ### Dependencies
@@ -220,12 +364,12 @@
220
364
  * devDependencies
221
365
  * @twin.org/entity-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
222
366
 
223
- ## [0.0.1-next.31](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.30...entity-storage-connector-postgresql-v0.0.1-next.31) (2025-06-20)
367
+ ## [0.0.1-next.31](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.30...entity-storage-connector-postgresql-v0.0.1-next.31) (2025-06-20)
224
368
 
225
369
 
226
370
  ### Bug Fixes
227
371
 
228
- * query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
372
+ * query params force coercion ([dd6aa87](https://github.com/iotaledger/twin-entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
229
373
 
230
374
 
231
375
  ### Dependencies
@@ -236,12 +380,12 @@
236
380
  * devDependencies
237
381
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
238
382
 
239
- ## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.29...entity-storage-connector-postgresql-v0.0.1-next.30) (2025-06-12)
383
+ ## [0.0.1-next.30](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.29...entity-storage-connector-postgresql-v0.0.1-next.30) (2025-06-12)
240
384
 
241
385
 
242
386
  ### Features
243
387
 
244
- * update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
388
+ * update dependencies ([7ccc0c4](https://github.com/iotaledger/twin-entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
245
389
 
246
390
 
247
391
  ### Dependencies
@@ -252,12 +396,12 @@
252
396
  * devDependencies
253
397
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
254
398
 
255
- ## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.28...entity-storage-connector-postgresql-v0.0.1-next.29) (2025-04-17)
399
+ ## [0.0.1-next.29](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.28...entity-storage-connector-postgresql-v0.0.1-next.29) (2025-04-17)
256
400
 
257
401
 
258
402
  ### Features
259
403
 
260
- * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
404
+ * use shared store mechanism ([#34](https://github.com/iotaledger/twin-entity-storage/issues/34)) ([68b6b71](https://github.com/iotaledger/twin-entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
261
405
 
262
406
 
263
407
  ### Dependencies
@@ -268,7 +412,7 @@
268
412
  * devDependencies
269
413
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
270
414
 
271
- ## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.27...entity-storage-connector-postgresql-v0.0.1-next.28) (2025-04-09)
415
+ ## [0.0.1-next.28](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.27...entity-storage-connector-postgresql-v0.0.1-next.28) (2025-04-09)
272
416
 
273
417
 
274
418
  ### Miscellaneous Chores
@@ -284,7 +428,7 @@
284
428
  * devDependencies
285
429
  * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
286
430
 
287
- ## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.26...entity-storage-connector-postgresql-v0.0.1-next.27) (2025-03-28)
431
+ ## [0.0.1-next.27](https://github.com/iotaledger/twin-entity-storage/compare/entity-storage-connector-postgresql-v0.0.1-next.26...entity-storage-connector-postgresql-v0.0.1-next.27) (2025-03-28)
288
432
 
289
433
 
290
434
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,98 @@
1
- # @twin.org/entity-storage-connector-postgresql - Examples
1
+ # Entity Storage Connector PostgreSQL Examples
2
+
3
+ These snippets demonstrate day-to-day usage with PostgreSQL, including setup, CRUD operations, conditional query calls, and table cleanup.
4
+
5
+ ## PostgreSqlEntityStorageConnector
6
+
7
+ ```typescript
8
+ import {
9
+ PostgreSqlEntityStorageConnector,
10
+ type IPostgreSqlEntityStorageConnectorConstructorOptions
11
+ } from '@twin.org/entity-storage-connector-postgresql';
12
+ import {
13
+ ComparisonOperator,
14
+ LogicalOperator,
15
+ SortDirection,
16
+ type EntityCondition
17
+ } from '@twin.org/entity';
18
+
19
+ interface Profile {
20
+ id: string;
21
+ email: string;
22
+ status: 'active' | 'inactive';
23
+ createdAt: string;
24
+ }
25
+
26
+ const options: IPostgreSqlEntityStorageConnectorConstructorOptions = {
27
+ entitySchema: 'Profile',
28
+ config: {
29
+ host: 'localhost',
30
+ port: 5432,
31
+ user: 'postgres',
32
+ password: 'postgres',
33
+ database: 'entity_storage',
34
+ tableName: 'profiles'
35
+ }
36
+ };
37
+
38
+ const connector = new PostgreSqlEntityStorageConnector<Profile>(options);
39
+ await connector.bootstrap();
40
+
41
+ const className = connector.className();
42
+ const schema = connector.getSchema();
43
+
44
+ await connector.set({
45
+ id: 'profile-1',
46
+ email: 'ada@example.com',
47
+ status: 'active',
48
+ createdAt: '2026-03-09T10:30:00.000Z'
49
+ });
50
+
51
+ const byPrimaryKey = await connector.get('profile-1');
52
+ const bySecondaryIndex = await connector.get('ada@example.com', 'email');
53
+
54
+ const activeCondition: EntityCondition<Profile> = {
55
+ logicalOperator: LogicalOperator.And,
56
+ conditions: [
57
+ {
58
+ property: 'status',
59
+ comparison: ComparisonOperator.Equals,
60
+ value: 'active'
61
+ }
62
+ ]
63
+ };
64
+
65
+ const result = await connector.query(
66
+ activeCondition,
67
+ [{ property: 'createdAt', sortDirection: SortDirection.Descending }],
68
+ ['id', 'email', 'status'],
69
+ undefined,
70
+ 25
71
+ );
72
+
73
+ await connector.remove('profile-1');
74
+ ```
75
+
76
+ ```typescript
77
+ import { PostgreSqlEntityStorageConnector } from '@twin.org/entity-storage-connector-postgresql';
78
+
79
+ interface Profile {
80
+ id: string;
81
+ email: string;
82
+ status: 'active' | 'inactive';
83
+ createdAt: string;
84
+ }
85
+
86
+ const connector = new PostgreSqlEntityStorageConnector<Profile>({
87
+ entitySchema: 'Profile',
88
+ config: {
89
+ host: 'localhost',
90
+ user: 'postgres',
91
+ password: 'postgres',
92
+ database: 'entity_storage',
93
+ tableName: 'profiles'
94
+ }
95
+ });
96
+
97
+ await connector.tableDrop();
98
+ ```