@twin.org/entity-storage-connector-scylladb 0.0.1-next.10

package/docs/reference/classes/ScyllaDBViewConnector.md

@@ -0,0 +1,252 @@
+# Class: ScyllaDBViewConnector\<T\>
+
+Manage entities using ScyllaDB Views.
+
+## Extends
+
+- `AbstractScyllaDBConnector`\<`T`\>
+
+## Type Parameters
+
+• **T**
+
+## Implements
+
+- `IEntityStorageConnector`\<`T`\>
+
+## Constructors
+
+### new ScyllaDBViewConnector()
+
+> **new ScyllaDBViewConnector**\<`T`\>(`options`): [`ScyllaDBViewConnector`](ScyllaDBViewConnector.md)\<`T`\>
+
+Create a new instance of ScyllaDBViewConnector.
+
+#### Parameters
+
+• **options**
+
+The options for the connector.
+
+• **options.loggingConnectorType?**: `string`
+
+The type of logging connector to use, defaults to "logging".
+
+• **options.entitySchema**: `string`
+
+The name of the entity schema.
+
+• **options.viewSchema**: `string`
+
+The name of the view schema.
+
+• **options.config**: [`IScyllaDBViewConfig`](../interfaces/IScyllaDBViewConfig.md)
+
+The configuration for the connector.
+
+#### Returns
+
+[`ScyllaDBViewConnector`](ScyllaDBViewConnector.md)\<`T`\>
+
+#### Overrides
+
+`AbstractScyllaDBConnector<T>.constructor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IEntityStorageConnector.CLASS_NAME`
+
+#### Overrides
+
+`AbstractScyllaDBConnector.CLASS_NAME`
+
+## Methods
+
+### getSchema()
+
+> **getSchema**(): `IEntitySchema`\<`unknown`\>
+
+Get the schema for the entities.
+
+#### Returns
+
+`IEntitySchema`\<`unknown`\>
+
+The schema for the entities.
+
+#### Implementation of
+
+`IEntityStorageConnector.getSchema`
+
+#### Inherited from
+
+`AbstractScyllaDBConnector.getSchema`
+
+***
+
+### get()
+
+> **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
+
+Get an entity.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to get.
+
+• **secondaryIndex?**: keyof `T`
+
+Get the item using a secondary index.
+
+• **conditions?**: `object`[]
+
+The optional conditions to match for the entities.
+
+#### Returns
+
+`Promise`\<`undefined` \| `T`\>
+
+The object if it can be found or undefined.
+
+#### Implementation of
+
+`IEntityStorageConnector.get`
+
+#### Inherited from
+
+`AbstractScyllaDBConnector.get`
+
+***
+
+### query()
+
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Find 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 page of entities.
+
+• **pageSize?**: `number`
+
+The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+##### entities
+
+> **entities**: `Partial`\<`T`\>[]
+
+The entities, which can be partial if a limited keys list was provided.
+
+##### cursor?
+
+> `optional` **cursor**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.
+
+#### Implementation of
+
+`IEntityStorageConnector.query`
+
+#### Inherited from
+
+`AbstractScyllaDBConnector.query`
+
+***
+
+### bootstrap()
+
+> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+• **nodeLoggingConnectorType?**: `string`
+
+The node logging connector type, defaults to "node-logging".
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Implementation of
+
+`IEntityStorageConnector.bootstrap`
+
+***
+
+### set()
+
+> **set**(`entity`): `Promise`\<`void`\>
+
+Set an entity.
+
+#### Parameters
+
+• **entity**: `T`
+
+The entity to set.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IEntityStorageConnector.set`
+
+***
+
+### remove()
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Delete the entity.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the entity to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IEntityStorageConnector.remove`

package/docs/reference/index.md

@@ -0,0 +1,11 @@
+# @twin.org/entity-storage-connector-scylladb
+
+## Classes
+
+- [ScyllaDBTableConnector](classes/ScyllaDBTableConnector.md)
+- [ScyllaDBViewConnector](classes/ScyllaDBViewConnector.md)
+
+## Interfaces
+
+- [IScyllaDBTableConfig](interfaces/IScyllaDBTableConfig.md)
+- [IScyllaDBViewConfig](interfaces/IScyllaDBViewConfig.md)

package/docs/reference/interfaces/IScyllaDBTableConfig.md

@@ -0,0 +1,61 @@
+# Interface: IScyllaDBTableConfig
+
+Definition of MySQL DB configuration.
+
+## Extends
+
+- `IScyllaDBConfig`
+
+## Extended by
+
+- [`IScyllaDBViewConfig`](IScyllaDBViewConfig.md)
+
+## Properties
+
+### hosts
+
+> **hosts**: `string`[]
+
+The host to contact to.
+
+#### Inherited from
+
+`IScyllaDBConfig.hosts`
+
+***
+
+### localDataCenter
+
+> **localDataCenter**: `string`
+
+The local data center.
+
+#### Inherited from
+
+`IScyllaDBConfig.localDataCenter`
+
+***
+
+### keyspace
+
+> **keyspace**: `string`
+
+The keyspace to use.
+
+#### Inherited from
+
+`IScyllaDBConfig.keyspace`
+
+***
+
+### tableName?
+
+> `optional` **tableName**: `string`
+
+The name of the table for the storage.
+
+#### Default
+
+```ts
+To the camel case of the entity name.
+```

package/docs/reference/interfaces/IScyllaDBViewConfig.md

@@ -0,0 +1,75 @@
+# Interface: IScyllaDBViewConfig
+
+Definition of MySQL DB configuration.
+
+## Extends
+
+- [`IScyllaDBTableConfig`](IScyllaDBTableConfig.md)
+
+## Properties
+
+### hosts
+
+> **hosts**: `string`[]
+
+The host to contact to.
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`hosts`](IScyllaDBTableConfig.md#hosts)
+
+***
+
+### localDataCenter
+
+> **localDataCenter**: `string`
+
+The local data center.
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`localDataCenter`](IScyllaDBTableConfig.md#localdatacenter)
+
+***
+
+### keyspace
+
+> **keyspace**: `string`
+
+The keyspace to use.
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`keyspace`](IScyllaDBTableConfig.md#keyspace)
+
+***
+
+### tableName?
+
+> `optional` **tableName**: `string`
+
+The name of the table for the storage.
+
+#### Default
+
+```ts
+To the camel case of the entity name.
+```
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`tableName`](IScyllaDBTableConfig.md#tablename)
+
+***
+
+### viewName?
+
+> `optional` **viewName**: `string`
+
+The name of view.
+
+#### Default
+
+```ts
+To the camel case of the entity name with View appended.
+```

package/locales/en.json

@@ -0,0 +1,28 @@
+{
+	"info": {
+		"scyllaDBTableConnector": {
+			"tableCreating": "Creating table \"{table}\"",
+			"tableCreated": "Created table \"{table}\"",
+			"tableExists": "Skipping create table \"{table}\" as it already exists",
+			"typeCreated": "Created type \"{typeName}\"",
+			"sql": "SQL: \"{sql}\""
+		},
+		"scyllaDBViewConnector": {
+			"viewCreating": "Creating view \"{view}\"",
+			"viewCreated": "Created view \"{view}\"",
+			"viewExists": "Skipping create view \"{view}\" as it already exists",
+			"typeCreated": "Created type \"{typeName}\"",
+			"sql": "SQL: \"{sql}\""
+		}
+	},
+	"error": {
+		"scyllaDBTableConnector": {
+			"tableCreateFailed": "Creating table \"{table}\" failed",
+			"getFailed": "Getting item with \"{id}\" failed",
+			"dropTableFailed": " \"{table}\" cannot be dropped",
+			"truncateTableFailed": " \"{table}\" cannot be dropped",
+			"removeFailed": "Removing item with \"{id}\" failed",
+			"findFailed": "Error while querying data on  \"{table}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@twin.org/entity-storage-connector-scylladb",
+	"version": "0.0.1-next.10",
+	"description": "Entity Storage connector implementation using ScyllaDB",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"directory": "packages/entity-storage-connector-scylladb"
+	},
+	"author": "jose.cantera@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.1-next.10",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"cassandra-driver": "^4.7.2"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}