🌳 DeepBase Redis

DeepBaseRedis is an innovative and efficient module designed to seamlessly integrate with Redis Stack, providing a robust solution for managing and interacting with databases. With DeepBaseRedis, you can effortlessly perform CRUD operations and manipulate data stored in Redis Stack (RedisJSON Module) keys.

For simplicity you may be interested in the version of DeepBase that persists in JSON files. https://www.npmjs.com/package/deepbase

📦 Installation

1# DeepBaseRedis requires Redis Stack, which includes the necessary RedisJSON module.
2docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
3
4npm install deepbase-redis

🔧 Usage

1import DeepBase from "deepbase-redis"
2const mem = new DeepBase({ name: "db" }); // "db" redis prefix
3await mem.connect();

✍️ Setting Values

1await mem.set("config", "lang", "en");
2
3const configLang = await mem.get("config", "lang");
4console.log(configLang); // "en"

✅ Adding Rows

1const path = await mem.add("user", { name: "martin" });
2
3// add() will create a secure key (ie. "CqtOILTDUg")
4console.log(path) // [ 'user', 'CqtOILTDUg' ]
5
6const userName = await mem.get(...path, "name");
7console.log(userName); // "martin"

🔢 Increment fields

1await mem.inc(...path, "balance", 160);
2await mem.inc(...path, "balance", 420);
3
4const userBalance = await mem.get(...path, "balance");
5console.log(userBalance); // 580

⚗️ Update

1await mem.upd("config", "lang", v => v.toUpperCase());
2const lang = await mem.get("config", "lang"); // EN

🔥 Finally

1await mem.add("user", { name: "anya" });
2
3const userIds = await mem.keys("user")
4console.log(userIds) // [ 'CqtOILTDUg', 'MXOlTBSmEf' ]
5
6console.log(await mem.get())
7// {
8//     config: { lang: 'EN' },
9//     user: {
10//         CqtOILTDUg: { name: 'martin', balance: 580 },
11//         MXOlTBSmEf: { name: 'anya' }
12//     }
13// }

🤯 Features

• 🔍 Easily access and modify nested objects in JSON storage.
• 📁 Provides an easy-to-use interface for connecting to RedisJSON and performing data operations, saving development.
• 🌱 Simple and intuitive API for managing complex JSON structures.

🤔 Why DeepBase

• ⚡ Fastest and simplest way to add persistence to your projects.
• 📖 Offers advanced querying capabilities, nested value retrieval, and seamless update processes.
• 🧠 Easy to use and understand.

🤝 Contributing

Contributions to DeepBase are welcome! If you have an idea or a bug to report, please open an issue. If you would like to contribute to the code, please open a pull request.

🎬 Conclusion

DeepBaseRedis is built with efficiency and performance in mind, leveraging the power of the Redis Stack driver and optimizing data access operations. Whether you're building a small-scale application or a complex system, DeepBaseRedis empowers you to interact with Redis Stack effortlessly, making your development process smoother and more efficient.

🚀 Try DeepBaseRedis today and experience the convenience and power it brings to your Redis Stack data management workflow!

📄 License

The MIT License (MIT)

Copyright (c) Martin Clasen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.