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

package/docs/examples.md

@@ -1 +1,98 @@
-# @twin.org/entity-storage-connector-postgresql - Examples
+# Entity Storage Connector PostgreSQL Examples
+
+These snippets demonstrate day-to-day usage with PostgreSQL, including setup, CRUD operations, conditional query calls, and table cleanup.
+
+## PostgreSqlEntityStorageConnector
+
+```typescript
+import {
+  PostgreSqlEntityStorageConnector,
+  type IPostgreSqlEntityStorageConnectorConstructorOptions
+} from '@twin.org/entity-storage-connector-postgresql';
+import {
+  ComparisonOperator,
+  LogicalOperator,
+  SortDirection,
+  type EntityCondition
+} from '@twin.org/entity';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const options: IPostgreSqlEntityStorageConnectorConstructorOptions = {
+  entitySchema: 'Profile',
+  config: {
+    host: 'localhost',
+    port: 5432,
+    user: 'postgres',
+    password: 'postgres',
+    database: 'entity_storage',
+    tableName: 'profiles'
+  }
+};
+
+const connector = new PostgreSqlEntityStorageConnector<Profile>(options);
+await connector.bootstrap();
+
+const className = connector.className();
+const schema = connector.getSchema();
+
+await connector.set({
+  id: 'profile-1',
+  email: 'ada@example.com',
+  status: 'active',
+  createdAt: '2026-03-09T10:30:00.000Z'
+});
+
+const byPrimaryKey = await connector.get('profile-1');
+const bySecondaryIndex = await connector.get('ada@example.com', 'email');
+
+const activeCondition: EntityCondition<Profile> = {
+  logicalOperator: LogicalOperator.And,
+  conditions: [
+    {
+      property: 'status',
+      comparison: ComparisonOperator.Equals,
+      value: 'active'
+    }
+  ]
+};
+
+const result = await connector.query(
+  activeCondition,
+  [{ property: 'createdAt', sortDirection: SortDirection.Descending }],
+  ['id', 'email', 'status'],
+  undefined,
+  25
+);
+
+await connector.remove('profile-1');
+```
+
+```typescript
+import { PostgreSqlEntityStorageConnector } from '@twin.org/entity-storage-connector-postgresql';
+
+interface Profile {
+  id: string;
+  email: string;
+  status: 'active' | 'inactive';
+  createdAt: string;
+}
+
+const connector = new PostgreSqlEntityStorageConnector<Profile>({
+  entitySchema: 'Profile',
+  config: {
+    host: 'localhost',
+    user: 'postgres',
+    password: 'postgres',
+    database: 'entity_storage',
+    tableName: 'profiles'
+  }
+});
+
+await connector.tableDrop();
+```

package/docs/reference/classes/PostgreSqlEntityStorageConnector.md

@@ -10,7 +10,7 @@ Class for performing entity storage operations using ql.
 
 ## Implements
 
-- `IEntityStorageConnector`\<`T`\>
+- `IEntityStorageMigrationConnector`\<`T`\>
 
 ## Constructors
 
@@ -34,7 +34,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -42,7 +42,7 @@ Runtime name for the class.
 
 ## Methods
 
-### bootstrap()
+### bootstrap() {#bootstrap}
 
 > **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
@@ -64,11 +64,11 @@ A promise that resolves to a boolean indicating success.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageMigrationConnector.bootstrap`
 
 ***
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -82,11 +82,47 @@ The class name of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.className`
+`IEntityStorageMigrationConnector.className`
 
 ***
 
-### getSchema()
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Get the health of the component.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health of the component.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.health`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.stop`
+
+***
+
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -100,11 +136,11 @@ The schema for the entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.getSchema`
+`IEntityStorageMigrationConnector.getSchema`
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
@@ -138,11 +174,11 @@ The object if it can be found or undefined.
 
 #### Implementation of
 
-`IEntityStorageConnector.get`
+`IEntityStorageMigrationConnector.get`
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -170,11 +206,55 @@ The id of the entity.
 
 #### Implementation of
 
-`IEntityStorageConnector.set`
+`IEntityStorageMigrationConnector.set`
 
 ***
 
-### remove()
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.setBatch`
+
+***
+
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Empty all the entities.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.empty`
+
+***
+
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -202,11 +282,199 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.remove`
+`IEntityStorageMigrationConnector.remove`
+
+***
+
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by their primary key IDs.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+The ids of the entities to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.removeBatch`
+
+***
+
+### teardown() {#teardown}
+
+> **teardown**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Teardown the entity storage by dropping the table.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the teardown process was successful.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.teardown`
+
+***
+
+### getPartitionContextIds() {#getpartitioncontextids}
+
+> **getPartitionContextIds**(): `Promise`\<`IContextIds`[]\>
+
+Get all the distinct partition context ids from the storage.
+
+#### Returns
+
+`Promise`\<`IContextIds`[]\>
+
+An array of context id objects, one per unique partition.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.getPartitionContextIds`
+
+***
+
+### createTargetConnector() {#createtargetconnector}
+
+> **createTargetConnector**\<`U`\>(`entitySchemaName`): `Promise`\<`PostgreSqlEntityStorageConnector`\<`U`\>\>
+
+Create a new target connector for the migration.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### entitySchemaName
+
+`string`
+
+The entity schema name to use for the target connector.
+
+#### Returns
+
+`Promise`\<`PostgreSqlEntityStorageConnector`\<`U`\>\>
+
+A new connector configured with a migration table name.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.createTargetConnector`
 
 ***
 
-### query()
+### finalizeMigration() {#finalizemigration}
+
+> **finalizeMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`PostgreSqlEntityStorageConnector`\<`U`\>\>
+
+Finalize the migration by renaming the migration table to the original table name.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`PostgreSqlEntityStorageConnector`\<`U`\>
+
+The connector pointing to the migration table.
+
+##### options?
+
+`IMigrationOptions`\<`T`, `U`\>
+
+The optional migration options.
+
+##### loggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`PostgreSqlEntityStorageConnector`\<`U`\>\>
+
+A connector pointing to the final (renamed) table.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.finalizeMigration`
+
+***
+
+### cleanupMigration() {#cleanupmigration}
+
+> **cleanupMigration**\<`U`\>(`targetConnector?`, `options?`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Clean up the migration by tearing down the migration table.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector?
+
+`PostgreSqlEntityStorageConnector`\<`U`\>
+
+The connector pointing to the migration table.
+
+##### options?
+
+`IMigrationOptions`\<`T`, `U`\>
+
+The optional migration options.
+
+##### loggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.cleanupMigration`
+
+***
+
+### query() {#query}
 
 > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
@@ -253,18 +521,30 @@ and a cursor which can be used to request more entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.query`
+`IEntityStorageMigrationConnector.query`
 
 ***
 
-### tableDrop()
+### count() {#count}
+
+> **count**(`conditions?`): `Promise`\<`number`\>
 
-> **tableDrop**(): `Promise`\<`void`\>
+Count all the entities which match the conditions.
 
-Drop the table.
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`T`\>
+
+The optional conditions to match for the entities.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`number`\>
 
-Nothing.
+The total count of entities in the storage.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.count`

package/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConfig.md

@@ -4,7 +4,7 @@ Configuration for the PostgreSql Entity Storage Connector.
 
 ## Properties
 
-### host
+### host {#host}
 
 > **host**: `string`
 
@@ -12,15 +12,15 @@ The host for the PostgreSql instance.
 
 ***
 
-### port?
+### port? {#port}
 
-> `optional` **port**: `number`
+> `optional` **port?**: `number`
 
 The port for the PostgreSql instance.
 
 ***
 
-### user
+### user {#user}
 
 > **user**: `string`
 
@@ -28,7 +28,7 @@ The user for the PostgreSql instance.
 
 ***
 
-### password
+### password {#password}
 
 > **password**: `string`
 
@@ -36,7 +36,7 @@ The password for the PostgreSql instance.
 
 ***
 
-### database
+### database {#database}
 
 > **database**: `string`
 
@@ -44,7 +44,7 @@ The name of the database to be used.
 
 ***
 
-### tableName
+### tableName {#tablename}
 
 > **tableName**: `string`
 

package/docs/reference/interfaces/IPostgreSqlEntityStorageConnectorConstructorOptions.md

@@ -4,7 +4,7 @@ The options for the PostgreSql entity storage connector constructor.
 
 ## Properties
 
-### entitySchema
+### entitySchema {#entityschema}
 
 > **entitySchema**: `string`
 
@@ -12,17 +12,17 @@ The schema for the entity.
 
 ***
 
-### partitionContextIds?
+### partitionContextIds? {#partitioncontextids}
 
-> `optional` **partitionContextIds**: `string`[]
+> `optional` **partitionContextIds?**: `string`[]
 
 The keys to use from the context ids to create partitions.
 
 ***
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 The type of logging component to use.
 
@@ -34,7 +34,7 @@ logging
 
 ***
 
-### config
+### config {#config}
 
 > **config**: [`IPostgreSqlEntityStorageConnectorConfig`](IPostgreSqlEntityStorageConnectorConfig.md)
 

package/locales/en.json

@@ -4,7 +4,9 @@
 			"databaseCreating": "Database \"{databaseName}\" creating",
 			"databaseExists": "Database \"{databaseName}\" created or it already exists",
 			"tableCreating": "Table \"{tableName}\" creating",
-			"tableExists": "Table \"{tableName}\" created or it already exists"
+			"tableExists": "Table \"{tableName}\" created or it already exists",
+			"tableDropping": "Dropping table \"{tableName}\"",
+			"tableDropped": "Table \"{tableName}\" dropped"
 		}
 	},
 	"error": {
@@ -16,7 +18,20 @@
 			"queryFailed": "The query failed",
 			"comparisonNotSupported": "Comparison operator \"{comparison}\" is not supported",
 			"conditionalNotSupported": "Conditional operator \"{operator}\" is not supported",
-			"entitySchemaPropertiesUndefined": "The entity schema properties are undefined"
+			"entitySchemaPropertiesUndefined": "The entity schema properties are undefined",
+			"setBatchFailed": "Unable to set batch of entities",
+			"countFailed": "Unable to count entities",
+			"emptyFailed": "Unable to empty entity storage",
+			"removeBatchFailed": "Unable to remove batch of entities",
+			"teardownFailed": "Unable to teardown entity storage",
+			"getPartitionContextIdsFailed": "Unable to get partition context ids",
+			"finalizeMigrationFailedBootstrap": "Finalizing migration failed during bootstrap phase"
+		}
+	},
+	"health": {
+		"postgreSqlEntityStorageConnector": {
+			"healthDescription": "Checks if the PostgreSQL table \"{tableName}\" is available",
+			"connectionFailed": "Failed to connect to PostgreSQL table \"{tableName}\""
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-connector-postgresql",
-	"version": "0.0.3-next.2",
-	"description": "Entity Storage connector implementation using PostgreSql storage",
+	"version": "0.0.3-next.20",
+	"description": "PostgreSQL connector for relational persistence and advanced SQL features.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"url": "git+https://github.com/iotaledger/twin-entity-storage.git",
 		"directory": "packages/entity-storage-connector-postgresql"
 	},
 	"author": "adrian.sanchez.sequeira@iota.org",
@@ -17,10 +17,10 @@
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.3-next.2",
+		"@twin.org/entity-storage-models": "0.0.3-next.20",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
-		"postgres": "3.4.7"
+		"postgres": "3.4.9"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -54,7 +54,7 @@
 		"integration"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/entity-storage/issues"
+		"url": "git+https://github.com/iotaledger/twin-entity-storage/issues"
 	},
 	"homepage": "https://twindev.org"
 }