@twin.org/entity-storage-models 0.0.3-next.3 → 0.0.3-next.30

package/docs/reference/interfaces/IEntityStorageConnector.md

@@ -6,6 +6,10 @@ Interface describing an entity storage connector.
 
 - `IComponent`
 
+## Extended by
+
+- [`IEntityStorageMigrationConnector`](IEntityStorageMigrationConnector.md)
+
 ## Type Parameters
 
 ### T
@@ -14,7 +18,7 @@ Interface describing an entity storage connector.
 
 ## Methods
 
-### getSchema()
+### getSchema() {#getschema}
 
 > **getSchema**(): `IEntitySchema`
 
@@ -28,7 +32,7 @@ The schema for the entities.
 
 ***
 
-### set()
+### set() {#set}
 
 > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
@@ -56,7 +60,29 @@ The id of the entity.
 
 ***
 
-### get()
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### get() {#get}
 
 > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
 
@@ -90,7 +116,7 @@ The object if it can be found or undefined.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
@@ -118,7 +144,29 @@ Nothing.
 
 ***
 
-### query()
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+The ids of the entities to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### query() {#query}
 
 > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
@@ -162,3 +210,39 @@ The suggested number of entities to return in each chunk, in some scenarios can
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
+
+***
+
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Remove all entities from the storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### count() {#count}
+
+> **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`\>
+
+The total count of entities in the storage.

package/docs/reference/interfaces/IEntityStorageCountRequest.md

@@ -0,0 +1,17 @@
+# Interface: IEntityStorageCountRequest
+
+Count the entries in entity storage.
+
+## Properties
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### conditions?
+
+> `optional` **conditions?**: `string`
+
+The optional conditions to filter the count, JSON encoded EntityCondition.

package/docs/reference/interfaces/IEntityStorageCountResponse.md

@@ -0,0 +1,17 @@
+# Interface: IEntityStorageCountResponse
+
+The response for counting entries in entity storage.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The body of the response.
+
+#### count
+
+> **count**: `number`
+
+The total count of entities.

package/docs/reference/interfaces/IEntityStorageEmptyRequest.md

@@ -0,0 +1,3 @@
+# Interface: IEntityStorageEmptyRequest
+
+Remove all entries from entity storage.

package/docs/reference/interfaces/IEntityStorageGetRequest.md

@@ -4,7 +4,7 @@ Get an entry from entity storage.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,14 +18,20 @@ The id of the entity to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### secondaryIndex?
 
-> `optional` **secondaryIndex**: `string`
+> `optional` **secondaryIndex?**: `string`
 
 The secondary index to query with the id.
+
+#### conditions?
+
+> `optional` **conditions?**: `string`
+
+The optional conditions to match for the entity, JSON encoded array of property/value pairs.

package/docs/reference/interfaces/IEntityStorageGetResponse.md

@@ -4,7 +4,7 @@ Get an entry from entity storage.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `unknown`
 

package/docs/reference/interfaces/IEntityStorageListRequest.md

@@ -4,44 +4,44 @@ Query the entries from entity storage.
 
 ## Properties
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The parameters from the query.
 
 #### conditions?
 
-> `optional` **conditions**: `string`
+> `optional` **conditions?**: `string`
 
 The condition for the query as JSON version of EntityCondition type.
 
 #### orderBy?
 
-> `optional` **orderBy**: `string`
+> `optional` **orderBy?**: `string`
 
 The order property for the results.
 
 #### orderByDirection?
 
-> `optional` **orderByDirection**: `SortDirection`
+> `optional` **orderByDirection?**: `SortDirection`
 
 The direction for the order, defaults to desc.
 
 #### properties?
 
-> `optional` **properties**: `string`
+> `optional` **properties?**: `string`
 
 The properties to return in the response as a comma separated list, by default returns all properties.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Limit the number of entities to return.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get next chunk of data, returned in previous response.

package/docs/reference/interfaces/IEntityStorageListResponse.md

@@ -4,7 +4,7 @@ Response to getting the list of entries from a query.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -18,6 +18,6 @@ The entities from the query.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor for the next page.

package/docs/reference/interfaces/IEntityStorageMigrationConnector.md

@@ -0,0 +1,402 @@
+# Interface: IEntityStorageMigrationConnector\<T\>
+
+Interface describing an entity storage migration connector.
+
+## Extends
+
+- [`IEntityStorageConnector`](IEntityStorageConnector.md)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+## Methods
+
+### getSchema() {#getschema}
+
+> **getSchema**(): `IEntitySchema`
+
+Get the schema for the entities.
+
+#### Returns
+
+`IEntitySchema`
+
+The schema for the entities.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`getSchema`](IEntityStorageConnector.md#getschema)
+
+***
+
+### set() {#set}
+
+> **set**(`entity`, `conditions?`): `Promise`\<`void`\>
+
+Set an entity.
+
+#### Parameters
+
+##### entity
+
+`T`
+
+The entity to set.
+
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+The id of the entity.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`set`](IEntityStorageConnector.md#set)
+
+***
+
+### setBatch() {#setbatch}
+
+> **setBatch**(`entities`): `Promise`\<`void`\>
+
+Set multiple entities in a batch.
+
+#### Parameters
+
+##### entities
+
+`T`[]
+
+The entities to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`setBatch`](IEntityStorageConnector.md#setbatch)
+
+***
+
+### get() {#get}
+
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`T` \| `undefined`\>
+
+Get an entity.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the entity to get, or the index value if secondaryIndex is set.
+
+##### secondaryIndex?
+
+keyof `T`
+
+Get the item using a secondary index.
+
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+The object if it can be found or undefined.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`get`](IEntityStorageConnector.md#get)
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`, `conditions?`): `Promise`\<`void`\>
+
+Remove the entity.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the entity to remove.
+
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`remove`](IEntityStorageConnector.md#remove)
+
+***
+
+### removeBatch() {#removebatch}
+
+> **removeBatch**(`ids`): `Promise`\<`void`\>
+
+Remove multiple entities by id.
+
+#### Parameters
+
+##### ids
+
+`string`[]
+
+The ids of the entities to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`removeBatch`](IEntityStorageConnector.md#removebatch)
+
+***
+
+### query() {#query}
+
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+
+Query all the entities which match the conditions.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<`T`\>
+
+The conditions to match for the entities.
+
+##### sortProperties?
+
+`object`[]
+
+The optional sort order.
+
+##### properties?
+
+keyof `T`[]
+
+The optional properties to return, defaults to all.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+
+#### Returns
+
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`query`](IEntityStorageConnector.md#query)
+
+***
+
+### empty() {#empty}
+
+> **empty**(): `Promise`\<`void`\>
+
+Remove all entities from the storage.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`empty`](IEntityStorageConnector.md#empty)
+
+***
+
+### count() {#count}
+
+> **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`\>
+
+The total count of entities in the storage.
+
+#### Inherited from
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md).[`count`](IEntityStorageConnector.md#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.
+
+***
+
+### createTargetConnector() {#createtargetconnector}
+
+> **createTargetConnector**\<`U`\>(`newEntitySchema`): `Promise`\<[`IEntityStorageConnector`](IEntityStorageConnector.md)\<`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`](IEntityStorageConnector.md)\<`U`\>\>
+
+Connector for performing the migration.
+
+***
+
+### finalizeMigration() {#finalizemigration}
+
+> **finalizeMigration**\<`U`\>(`targetConnector`, `options?`, `loggingComponentType?`): `Promise`\<[`IEntityStorageConnector`](IEntityStorageConnector.md)\<`U`\>\>
+
+Finalize the migration by tearing down the old connector and replacing it with the target connector.
+
+#### Type Parameters
+
+##### U
+
+`U`
+
+#### Parameters
+
+##### targetConnector
+
+[`IEntityStorageConnector`](IEntityStorageConnector.md)\<`U`\>
+
+The target connector to finalize the migration with.
+
+##### options?
+
+[`IMigrationOptions`](IMigrationOptions.md)
+
+The options to control how the migration is finalized.
+
+##### loggingComponentType?
+
+`string`
+
+The optional component type to use for logging the migration progress.
+
+#### Returns
+
+`Promise`\<[`IEntityStorageConnector`](IEntityStorageConnector.md)\<`U`\>\>
+
+A promise that resolves when the migration is finalized and returns the final connector.
+
+***
+
+### 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`](IEntityStorageConnector.md)\<`U`\> \| `undefined`
+
+The target connector to cleanup the migration with.
+
+##### options?
+
+[`IMigrationOptions`](IMigrationOptions.md)
+
+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.

package/docs/reference/interfaces/IEntityStorageRemoveBatchRequest.md

@@ -0,0 +1,11 @@
+# Interface: IEntityStorageRemoveBatchRequest
+
+Remove multiple entries from entity storage by id.
+
+## Properties
+
+### body {#body}
+
+> **body**: `string`[]
+
+The ids of the entities to remove.