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

package/dist/types/abstractScyllaDBConnector.d.ts

@@ -0,0 +1,50 @@
+import { SortDirection, type EntityCondition } from "@twin.org/entity";
+import type { IScyllaDBTableConfig } from "./models/IScyllaDBTableConfig";
+/**
+ * Store entities using ScyllaDB.
+ */
+export declare abstract class AbstractScyllaDBConnector<T> {
+    /**
+     * Create a new instance of AbstractScyllaDBConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.entitySchema The name of the entity schema.
+     * @param options.config The configuration for the connector.
+     * @param className The name of the derived class.
+     */
+    constructor(options: {
+        loggingConnectorType?: string;
+        entitySchema: string;
+        config: IScyllaDBTableConfig;
+    }, className: string);
+    /**
+     * Get an entity.
+     * @param id The id of the entity to get.
+     * @param secondaryIndex Get the item using a secondary index.
+     * @returns The object if it can be found or undefined.
+     */
+    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
+    /**
+     * Find all the entities which match the conditions.
+     * @param conditions The conditions to match for the entities.
+     * @param sortProperties The optional sort order.
+     * @param properties The optional properties to return, defaults to all.
+     * @param cursor The cursor to request the next page of entities.
+     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @returns All the entities for the storage matching the conditions,
+     * and a cursor which can be used to request more entities.
+     */
+    query(conditions?: EntityCondition<T>, sortProperties?: {
+        property: keyof T;
+        sortDirection: SortDirection;
+    }[], properties?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The entities, which can be partial if a limited keys list was provided.
+         */
+        entities: Partial<T>[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./scyllaDBTableConnector";
+export * from "./scyllaDBViewConnector";
+export * from "./models/IScyllaDBTableConfig";
+export * from "./models/IScyllaDBViewConfig";

package/dist/types/models/IScyllaDBConfig.d.ts

@@ -0,0 +1,17 @@
+/**
+ * ScyllaDB Configuration.
+ */
+export interface IScyllaDBConfig {
+    /**
+     * The host to contact to.
+     */
+    hosts: string[];
+    /**
+     * The local data center.
+     */
+    localDataCenter: string;
+    /**
+     * The keyspace to use.
+     */
+    keyspace: string;
+}

package/dist/types/models/IScyllaDBTableConfig.d.ts

@@ -0,0 +1,11 @@
+import type { IScyllaDBConfig } from "./IScyllaDBConfig";
+/**
+ * Definition of MySQL DB configuration.
+ */
+export interface IScyllaDBTableConfig extends IScyllaDBConfig {
+    /**
+     * The name of the table for the storage.
+     * @default To the camel case of the entity name.
+     */
+    tableName?: string;
+}

package/dist/types/models/IScyllaDBViewConfig.d.ts

@@ -0,0 +1,11 @@
+import type { IScyllaDBTableConfig } from "./IScyllaDBTableConfig";
+/**
+ * Definition of MySQL DB configuration.
+ */
+export interface IScyllaDBViewConfig extends IScyllaDBTableConfig {
+    /**
+     * The name of view.
+     * @default To the camel case of the entity name with View appended.
+     */
+    viewName?: string;
+}

package/dist/types/scyllaDBTableConnector.d.ts

@@ -0,0 +1,48 @@
+import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
+import { AbstractScyllaDBConnector } from "./abstractScyllaDBConnector";
+import type { IScyllaDBTableConfig } from "./models/IScyllaDBTableConfig";
+/**
+ * Store entities using ScyllaDB.
+ */
+export declare class ScyllaDBTableConnector<T = unknown> extends AbstractScyllaDBConnector<T> implements IEntityStorageConnector<T> {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ScyllaDBTableConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
+     * @param options.entitySchema The name of the entity schema.
+     * @param options.config The configuration for the connector.
+     */
+    constructor(options: {
+        loggingConnectorType?: string;
+        entitySchema: string;
+        config: IScyllaDBTableConfig;
+    });
+    /**
+     * Bootstrap the component by creating and initializing any resources it needs.
+     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @returns True if the bootstrapping process was successful.
+     */
+    bootstrap(nodeLoggingConnectorType?: string): Promise<boolean>;
+    /**
+     * Set an entity.
+     * @param entity The entity to set.
+     */
+    set(entity: T): Promise<void>;
+    /**
+     * Delete the entity.
+     * @param id The id of the entity to remove.
+     */
+    remove(id: string): Promise<void>;
+    /**
+     * Drops table.
+     */
+    dropTable(): Promise<void>;
+    /**
+     * Truncates (clear) table.
+     */
+    truncateTable(): Promise<void>;
+}

package/dist/types/scyllaDBViewConnector.d.ts

@@ -0,0 +1,42 @@
+import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
+import { AbstractScyllaDBConnector } from "./abstractScyllaDBConnector";
+import type { IScyllaDBViewConfig } from "./models/IScyllaDBViewConfig";
+/**
+ * Manage entities using ScyllaDB Views.
+ */
+export declare class ScyllaDBViewConnector<T> extends AbstractScyllaDBConnector<T> implements IEntityStorageConnector<T> {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ScyllaDBViewConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
+     * @param options.entitySchema The name of the entity schema.
+     * @param options.viewSchema The name of the view schema.
+     * @param options.config The configuration for the connector.
+     */
+    constructor(options: {
+        loggingConnectorType?: string;
+        entitySchema: string;
+        viewSchema: string;
+        config: IScyllaDBViewConfig;
+    });
+    /**
+     * Bootstrap the component by creating and initializing any resources it needs.
+     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @returns True if the bootstrapping process was successful.
+     */
+    bootstrap(nodeLoggingConnectorType?: string): Promise<boolean>;
+    /**
+     * Set an entity.
+     * @param entity The entity to set.
+     */
+    set(entity: T): Promise<void>;
+    /**
+     * Delete the entity.
+     * @param id The id of the entity to remove.
+     */
+    remove(id: string): Promise<void>;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/entity-storage-connector-scylladb - Changelog
+
+## v0.0.1-next.2
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/entity-storage-connector-scylladb - Examples

package/docs/reference/classes/ScyllaDBTableConnector.md

@@ -0,0 +1,246 @@
+# Class: ScyllaDBTableConnector\<T\>
+
+Store entities using ScyllaDB.
+
+## Extends
+
+- `AbstractScyllaDBConnector`\<`T`\>
+
+## Type Parameters
+
+• **T** = `unknown`
+
+## Implements
+
+- `IEntityStorageConnector`\<`T`\>
+
+## Constructors
+
+### new ScyllaDBTableConnector()
+
+> **new ScyllaDBTableConnector**\<`T`\>(`options`): [`ScyllaDBTableConnector`](ScyllaDBTableConnector.md)\<`T`\>
+
+Create a new instance of ScyllaDBTableConnector.
+
+#### 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.config**: [`IScyllaDBTableConfig`](../interfaces/IScyllaDBTableConfig.md)
+
+The configuration for the connector.
+
+#### Returns
+
+[`ScyllaDBTableConnector`](ScyllaDBTableConnector.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
+
+### get()
+
+> **get**(`id`, `secondaryIndex`?): `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.
+
+#### 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`
+
+***
+
+### dropTable()
+
+> **dropTable**(): `Promise`\<`void`\>
+
+Drops table.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### truncateTable()
+
+> **truncateTable**(): `Promise`\<`void`\>
+
+Truncates (clear) table.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/classes/ScyllaDBViewConnector.md

@@ -0,0 +1,226 @@
+# 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
+
+### get()
+
+> **get**(`id`, `secondaryIndex`?): `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.
+
+#### 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)