@twin.org/entity-storage-connector-dynamodb 0.0.3-next.13 → 0.0.3-next.14

package/docs/reference/classes/DynamoDbEntityStorageConnector.md

@@ -10,7 +10,7 @@ Class for performing entity storage operations using Dynamo DB.
 
 ## Implements
 
-- `IEntityStorageConnector`\<`T`\>
+- `IEntityStorageMigrationConnector`\<`T`\>
 
 ## Constructors
 
@@ -56,7 +56,7 @@ The class name of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.className`
+`IEntityStorageMigrationConnector.className`
 
 ***
 
@@ -74,7 +74,7 @@ The health status of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.health`
+`IEntityStorageMigrationConnector.health`
 
 ***
 
@@ -92,7 +92,7 @@ The schema for the entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.getSchema`
+`IEntityStorageMigrationConnector.getSchema`
 
 ***
 
@@ -118,7 +118,7 @@ True if the bootstrapping process was successful.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageMigrationConnector.bootstrap`
 
 ***
 
@@ -156,7 +156,7 @@ The object if it can be found or undefined.
 
 #### Implementation of
 
-`IEntityStorageConnector.get`
+`IEntityStorageMigrationConnector.get`
 
 ***
 
@@ -188,7 +188,7 @@ The id of the entity.
 
 #### Implementation of
 
-`IEntityStorageConnector.set`
+`IEntityStorageMigrationConnector.set`
 
 ***
 
@@ -214,7 +214,7 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.setBatch`
+`IEntityStorageMigrationConnector.setBatch`
 
 ***
 
@@ -232,7 +232,7 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.empty`
+`IEntityStorageMigrationConnector.empty`
 
 ***
 
@@ -264,7 +264,7 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.remove`
+`IEntityStorageMigrationConnector.remove`
 
 ***
 
@@ -290,7 +290,7 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.removeBatch`
+`IEntityStorageMigrationConnector.removeBatch`
 
 ***
 
@@ -316,7 +316,7 @@ True if the teardown process was successful.
 
 #### Implementation of
 
-`IEntityStorageConnector.teardown`
+`IEntityStorageMigrationConnector.teardown`
 
 ***
 
@@ -367,16 +367,24 @@ and a cursor which can be used to request more entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.query`
+`IEntityStorageMigrationConnector.query`
 
 ***
 
 ### count() {#count}
 
-> **count**(): `Promise`\<`number`\>
+> **count**(`conditions?`): `Promise`\<`number`\>
 
 Count all the entities which match the conditions.
 
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`T`\>
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`number`\>
@@ -385,4 +393,142 @@ The total count of entities in the storage.
 
 #### Implementation of
 
-`IEntityStorageConnector.count`
+`IEntityStorageMigrationConnector.count`
+
+***
+
+### getPartitionContextIds() {#getpartitioncontextids}
+
+> **getPartitionContextIds**(): `Promise`\<`IContextIds`[]\>
+
+Get a unique list of all the context ids from the storage.
+
+#### Returns
+
+`Promise`\<`IContextIds`[]\>
+
+The list of unique context ids.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.getPartitionContextIds`
+
+***
+
+### createTargetConnector() {#createtargetconnector}
+
+> **createTargetConnector**\<`U`\>(`newEntitySchema`): `Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Create the target connector for performing the migration it will use a temporary storage location.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### newEntitySchema
+
+`string`
+
+The name of the new entity schema to create the connector for.
+
+#### Returns
+
+`Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Connector for performing the migration.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.createTargetConnector`
+
+***
+
+### finalizeMigration() {#finalizemigration}
+
+> **finalizeMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`DynamoDbEntityStorageConnector`\<`U`\>\>
+
+Finalize the migration by tearing down the old connector and replacing it with the new one.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`DynamoDbEntityStorageConnector`\<`U`\>
+
+The target connector to finalize the migration with.
+
+##### options?
+
+`IMigrationOptions`\<`T`, `U`\>
+
+The options to control how the migration is finalized.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type to use for logging during the migration finalization.
+
+#### Returns
+
+`Promise`\<`DynamoDbEntityStorageConnector`\<`U`\>\>
+
+A promise that resolves when the migration is finalized.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.finalizeMigration`
+
+***
+
+### cleanupMigration() {#cleanupmigration}
+
+> **cleanupMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Cleanup the migration if a migration fails or needs to be aborted.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`IEntityStorageConnector`\<`U`\> \| `undefined`
+
+The target connector to cleanup the migration with.
+
+##### options?
+
+`IMigrationOptions`\<`T`, `U`\>
+
+The options to control how the migration is cleaned up.
+
+##### loggingComponentType?
+
+`string`
+
+The optional component type to use for logging the migration progress.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the migration is cleaned up.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.cleanupMigration`

package/docs/reference/interfaces/IDynamoDbEntityStorageConnectorConfig.md

@@ -65,3 +65,12 @@ AWS endpoint, not usually required but could be used for local DynamoDB instance
 > `optional` **connectionTimeoutMs?**: `number`
 
 The connection timeout in milliseconds.
+
+***
+
+### maxAttempts? {#maxattempts}
+
+> `optional` **maxAttempts?**: `number`
+
+Maximum number of attempts for each SDK request (1 = no retries).
+Defaults to the AWS SDK default (3).

package/locales/en.json

@@ -21,11 +21,13 @@
 			"sortSingle": "You can only sort by a single property",
 			"sortNotIndexed": "The property \"{property}\" is not indexed and cannot be used for sorting",
 			"propertyNotFound": "The property \"{property}\" was not found on the entity schema",
+			"getPartitionContextIdsFailed": "Unable to get partition context ids",
 			"setBatchFailed": "Unable to set batch of entities",
 			"removeBatchFailed": "Unable to remove batch of entities",
 			"emptyFailed": "Unable to empty entity storage",
 			"countFailed": "Unable to count entities",
-			"teardownFailed": "Unable to teardown entity storage"
+			"teardownFailed": "Unable to teardown entity storage",
+			"finalizeMigrationFailedBootstrap": "Finalizing migration failed during bootstrap phase"
 		}
 	},
 	"health": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-dynamodb",
-	"version": "0.0.3-next.13",
+	"version": "0.0.3-next.14",
 	"description": "Amazon DynamoDB connector for managed NoSQL persistence.",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,13 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@aws-sdk/client-dynamodb": "3.1045",
-		"@aws-sdk/lib-dynamodb": "3.1045",
+		"@aws-sdk/client-dynamodb": "3.1049",
+		"@aws-sdk/lib-dynamodb": "3.1049",
 		"@aws-sdk/util-dynamodb": "3.996",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.3-next.13",
+		"@twin.org/entity-storage-models": "0.0.3-next.14",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},