Skip to main content

README

SpinelDB Logo

SpinelDB: Tutorials & Guides

Welcome to the official documentation and tutorial hub for SpinelDB. This collection of guides will walk you through setting up, using, and mastering SpinelDB, from the basics to our most advanced features.

📚 Command Reference​

For a complete list of all commands supported by SpinelDB, categorized by their functionality, please refer to the dedicated command reference:

🚀 Chapter 1: Getting Started​

This is the essential starting point for all new users. We'll get you up and running in minutes.

  • ➡️ 1. Installation & Setup
    • Building the project from source.
    • Understanding the config.toml file.
    • Running the SpinelDB server for the first time.
    • Connecting to the server with redis-cli.

⚙️ Chapter 2: Core Data Types​

Learn how to use SpinelDB just like you would use Redis. This chapter covers the fundamental commands and data types.

  • ➡️ 2. Core Data Types & Commands
    • Working with Strings (SET, GET, INCR, BITOP).
    • Managing Lists (LPUSH, LRANGE, RPOP).
    • Using Hashes (HSET, HGETALL, HINCRBY).
    • Operating on Sets (SADD, SISMEMBER, SUNION).
    • Understanding Sorted Sets (ZADD, ZRANGE, ZSCORE).
    • Introduction to Streams (XADD, XREAD, XGROUP).

✨ Chapter 3: Native Data Structures​

Explore SpinelDB's powerful, built-in support for modern data formats, enabling complex operations directly on the server.

🧠 Chapter 4: The Intelligent Caching Engine​

Dive deep into SpinelDB's flagship feature. Learn how to build a powerful, resilient, and automated caching layer, leveraging advanced capabilities like conditional revalidation, negative caching, and cluster-wide invalidation.

📈 Chapter 5: High Availability & Scalability​

Learn how to run SpinelDB in a robust, fault-tolerant, and scalable production environment.

🔐 Chapter 6: Advanced Features​

Master SpinelDB's powerful extended functionality.

📊 Chapter 7: Operations & Monitoring​

Keep your SpinelDB instances healthy and observable.

Need Help?​

If you have questions, find a bug, or have a feature request, please open an issue on our main repository. We welcome all contributions