@twin.org/entity-storage-connector-mysql 0.0.3-next.9 → 0.9.0

package/docs/reference/classes/MySqlEntityStorageConnector.md

@@ -10,7 +10,7 @@ Class for performing entity storage operations using MySql.
 
 ## Implements
 
-- `IEntityStorageConnector`\<`T`\>
+- `IEntityStorageMigrationConnector`\<`T`\>
 
 ## Constructors
 
@@ -56,7 +56,25 @@ The class name of the component.
 
 #### Implementation of
 
-`IEntityStorageConnector.className`
+`IEntityStorageMigrationConnector.className`
+
+***
+
+### health() {#health}
+
+> **health**(): `Promise`\<`IHealth`[]\>
+
+Get the health of the component.
+
+#### Returns
+
+`Promise`\<`IHealth`[]\>
+
+The health of the component.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.health`
 
 ***
 
@@ -74,7 +92,7 @@ The schema for the entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.getSchema`
+`IEntityStorageMigrationConnector.getSchema`
 
 ***
 
@@ -100,7 +118,7 @@ A promise that resolves to a boolean indicating success.
 
 #### Implementation of
 
-`IEntityStorageConnector.bootstrap`
+`IEntityStorageMigrationConnector.bootstrap`
 
 ***
 
@@ -126,7 +144,7 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.stop`
+`IEntityStorageMigrationConnector.stop`
 
 ***
 
@@ -164,7 +182,7 @@ The object if it can be found or undefined.
 
 #### Implementation of
 
-`IEntityStorageConnector.get`
+`IEntityStorageMigrationConnector.get`
 
 ***
 
@@ -196,7 +214,51 @@ The id of the entity.
 
 #### Implementation of
 
-`IEntityStorageConnector.set`
+`IEntityStorageMigrationConnector.set`
+
+***
+
+### 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 the entity storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.empty`
 
 ***
 
@@ -228,7 +290,59 @@ Nothing.
 
 #### Implementation of
 
-`IEntityStorageConnector.remove`
+`IEntityStorageMigrationConnector.remove`
+
+***
+
+### 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`
+
+***
+
+### 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`
 
 ***
 
@@ -279,35 +393,171 @@ and a cursor which can be used to request more entities.
 
 #### Implementation of
 
-`IEntityStorageConnector.query`
+`IEntityStorageMigrationConnector.query`
 
 ***
 
-### tableDrop() {#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`
+
+***
+
+### getPartitionContextIds() {#getpartitioncontextids}
+
+> **getPartitionContextIds**(): `Promise`\<`IContextIds`[]\>
+
+Get all unique partition context ids present in the table.
+
+#### Returns
+
+`Promise`\<`IContextIds`[]\>
+
+An array of context id objects, one per unique partition.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.getPartitionContextIds`
+
+***
+
+### createTargetConnector() {#createtargetconnector}
+
+> **createTargetConnector**\<`U`\>(`newEntitySchema`): `Promise`\<`IEntityStorageConnector`\<`U`\>\>
+
+Create the target connector for performing the migration using a temporary table.
+
+#### 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`\<`MySqlEntityStorageConnector`\<`U`\>\>
+
+Finalize the migration by dropping the source table and renaming the migration table to the original name.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+`MySqlEntityStorageConnector`\<`U`\>
+
+The connector holding the migrated data in a temporary table.
+
+##### options?
+
+`IMigrationOptions`
+
+The options to control how the migration is finalized.
+
+##### loggingComponentType?
+
+`string`
+
+The logging component type to use during finalization.
+
+#### Returns
+
+`Promise`\<`MySqlEntityStorageConnector`\<`U`\>\>
+
+The final connector using the original table name with the new schema.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.finalizeMigration`
 
 ***
 
-### tableEmpty() {#tableempty}
+### cleanupMigration() {#cleanupmigration}
+
+> **cleanupMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Cleanup a failed or aborted migration by dropping the temporary migration table.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
 
-> **tableEmpty**(): `Promise`\<`void`\>
+`IEntityStorageConnector`\<`U`\> \| `undefined`
 
-Empty the table.
+The target connector to cleanup.
+
+##### options?
+
+`IMigrationOptions`
+
+The options to control how the migration is cleaned up.
+
+##### loggingComponentType?
+
+`string`
+
+The optional component type to use for logging.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the cleanup is complete.
+
+#### Implementation of
+
+`IEntityStorageMigrationConnector.cleanupMigration`
 
 ***
 

package/docs/reference/interfaces/IMySqlEntityStorageConnectorConstructorOptions.md

@@ -26,12 +26,6 @@ The keys to use from the context ids to create partitions.
 
 The type of logging component to use.
 
-#### Default
-
-```ts
-logging
-```
-
 ***
 
 ### config {#config}

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 @@
 			"comparisonNotSupported": "Comparison operator \"{comparison}\" is not supported",
 			"conditionalNotSupported": "Conditional operator \"{operator}\" is not supported",
 			"entitySchemaPropertiesUndefined": "The entity schema properties are undefined",
-			"databaseCreateFailed": "Unable to create database \"{databaseName}\""
+			"databaseCreateFailed": "Unable to create database \"{databaseName}\"",
+			"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": {
+		"mySqlEntityStorageConnector": {
+			"healthDescription": "Checks if the MySQL table \"{tableName}\" in database \"{database}\" is available",
+			"connectionFailed": "Failed to connect to MySQL table \"{tableName}\" in database \"{database}\""
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/entity-storage-connector-mysql",
-	"version": "0.0.3-next.9",
+	"version": "0.9.0",
 	"description": "MySQL connector for relational persistence with SQL querying.",
 	"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-mysql"
 	},
 	"author": "adrian.sanchez.sequeira@iota.org",
@@ -14,14 +14,14 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/context": "next",
-		"@twin.org/core": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.3-next.9",
-		"@twin.org/logging-models": "next",
-		"@twin.org/nameof": "next",
-		"mysql2": "3.20.0"
+		"@twin.org/context": "^0.9.0",
+		"@twin.org/core": "^0.9.0",
+		"@twin.org/data-json-ld": "^0.9.0",
+		"@twin.org/entity": "^0.9.0",
+		"@twin.org/entity-storage-models": "^0.9.0",
+		"@twin.org/logging-models": "^0.9.0",
+		"@twin.org/nameof": "^0.9.0",
+		"mysql2": "3.22.5"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -55,7 +55,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"
 }