Documentation

๐Ÿš€ WeeDB: Persistent Data Storage for n8n

WeeDB Logo
Finally, a reliable way to store persistent data in n8n custom nodes!

๐ŸŽฏ The Problem

One of the most challenging aspects of n8n custom node development has been persistent data storage. Common issues include:

  • Data loss during node updates
  • No built-in persistent storage solution
  • State management complexity

๐Ÿ’ก The Solution

WeeDB solves these challenges by providing:

  1. True Persistence

    • Data stored in user's home directory (~/.weedb/)
    • Survives node updates and reinstalls
    • Cross-platform compatibility
  2. Simple API

    // Store data that persists!
    await weeDB.create({ key: "settings", value: "important-data" });
    
  3. Reliable Architecture

    ~/.weedb/
    โ”œโ”€โ”€ database1.json
    โ”œโ”€โ”€ database2.json
    โ””โ”€โ”€ settings/
        โ””โ”€โ”€ config.json
    

โšก Features

1. Persistent Storage

  • โœ… Survives node updates
  • โœ… Survives n8n restarts
  • โœ… Cross-platform support

2. Rich Operations

  • ๐Ÿ” Pattern-based search
  • ๐Ÿ—‘๏ธ Bulk operations
  • ๐Ÿ”„ Atomic updates

3. Safety Features

  • ๐Ÿงช Dry run mode
  • โš ๏ธ Operation confirmation
  • ๐Ÿ”’ Data integrity checks

๐Ÿ› ๏ธ Installation

npm install n8n-nodes-weedb

๐Ÿ“š Documentation

Basic Usage

// Store persistent data
WeeDB Create: { 
    key: "config", 
    value: { setting: "value" } 
}

// Retrieve anytime, anywhere
WeeDB Get: { 
    mode: "single", 
    key: "config" 
}

Advanced Features

// Pattern-based removal
WeeDB Remove: { 
    mode: "pattern",
    pattern: "temp_*",
    options: { dryRun: true }
}

โญ Support the Project

If you find WeeDB helpful, please consider giving it a star on GitHub! It helps make the project more visible to other n8n developers.

GitHub stars

Every star makes a difference!
Click the badge above to star the project on GitHub

Why Star?

  • Help other developers find this solution
  • Show your appreciation for the project
  • Stay updated on new features and releases
  • Join our growing community of n8n developers

๐ŸŽฏ Real-World Use Cases

  1. Configuration Storage

    • Store API credentials
    • Save user preferences
    • Maintain state between workflows
  2. Cache Management

    • Store API response cache
    • Maintain rate limit counters
    • Save temporary processing results
  3. Workflow State

    • Track long-running operations
    • Store checkpoint data
    • Maintain audit logs

๐Ÿค Contributing

Found a bug? Have a feature request? We'd love to hear from you! Check out our contribution guidelines.

๐Ÿ“œ License

MIT ยฉ Hossein Khoshraftar


Built with โค๏ธ for the n8n community

โญ Star us on GitHub

/\ \ /\ \ /\ _ \ _ \
\ \ /\ \ \ \ __ \ \ \L\ \ \ \
\ \ \ \ \ \ \L\ \ \ \ __ \ \ \
\ \ _/ \ _
/ \ \ \L\ \ _\
\ \___/\/___/ \ \_____\/\_\/ // /___//
/
WeeDB - Tiny but Mighty

Discussion