Soap Redis

Redis Collections for SoapJS. This page and the plugin itself are still in development, a lot will change.

This package provides a set of Redis collections that integrate seamlessly with the SoapJS framework, enabling efficient and structured data handling in Redis databases. It includes implementations for common Redis data structures like hashes, lists, sets, and sorted sets.

Features

• Easy-to-use Redis collections and query factories (RedisSearch).

• Integration with the SoapJS framework for structured, clean architecture.

• Support for Redis operations such as find, insert, update, and delete.

Collections Included

• RedisHashCollection: hashes, allowing storage and retrieval of data associated with a key.

• RedisListCollection: Redis lists, supporting pushing, popping, and range queries.

• RedisSetCollection: Redis sets, including adding, removing, and querying members.

• RedisSortedSetCollection: Redis sorted sets, enabling sorted data management and range-based queries.

Installation

To install the package, run the following command in your project directory:

npm install @soapjs/soap-node-redis

Ensure that you have the core @soapjs/soap and redis packages installed, as these collections depend on it.

Status: Proof of Concept

Please note that this package is currently in a Proof of Concept stage. This means that while it demonstrates potential applications and functionalities, it may not be suitable for production use. The implementation is intended to explore ideas and should be used as a reference or a starting point for further development rather than a complete solution.

Key Points

• The package is not fully tested across all possible use cases and scenarios.

• Performance and security aspects have not been fully optimized.

• API and functionalities may change as the project evolves.

Usage

1. Import the necessary components from the package:

   import {
     RedisListCollection,
     RedisConfig,
     RedisQueryFactory,
     RedisSource,
     RedisUtils
   } from '@soapjs/soap-node-redis';

2. Set up your Redis configuration:

   const config = new RedisConfig({
     hosts: ['localhost'],
     ports: ['27017'],
     iana: false,
     user: 'admin',
     password: 'admin',
     database: 'my_redis_db'
   });

3. Create a new RedisSource instance:

   const redisSource = await RedisSource.create(config);

4. Use collection to perform database operations:

   const collection = new RedisListCollection<MyDocumentType>(redisSource, 'users');
   const documents = await collection.list();

Limitations and Contributions

The current implementation covers basic functionalities of Redis collections. It is an ongoing project, and contributions are welcome to extend the capabilities and add new features.