PebbleVault

[!CAUTION] PebbleVault is still in early development and is not meant to be used in any production environments yet.

Welcome to PebbleVault, the database that rocks! 🚀 Imagine a world where pebbles are more than just tiny stones; they are the building blocks of your data dreams. PebbleVault is a memory database with a MySQL twist, all wrapped up in the cozy, memory-safe blanket of Rust. It’s like having a pet rock collection, but for grown-ups with serious data needs!

Why PebbleVault? 🌟

• Speed: With memory-based storage, your pebbles are accessible at lightning speed.
• Safety: Thanks to Rust, your data is as safe as pebbles in a vault. No more worrying about memory leaks or data corruption.
• Flexibility: Easily throw your pebbles to MySQL when you need more permanent storage. It's like tossing a pebble across a lake, but with fewer ripples and more data integrity.
• Simplicity: Simple operations to add, drop, and throw pebbles make managing your data as easy as skipping stones on a serene pond.
• Amazing dad jokes

Key Features 🎉

• In-Memory Speed: Keep your pebbles in memory for ultra-fast access.
• MySQL Persistence: Throw pebbles to MySQL for long-term storage, ensuring your data stays solid.
• Rust Reliability: Built with Rust, so your pebbles are safe and sound, protected from the elements (and by elements, we mean bugs).

Operations 🔧

Define Class (Create Pebble Class)

Define a class of pebbles with specific fields and field types using JSON.

vault.define_class("gem", r#"{
    "name": "string",
    "color": "string",
    "carat": "float"
}"#);

Collect (Insert Data)

Store a pebble (data object) in memory.

vault.collect("gem", "my_precious_pebble", r#"{
    "name": "Ruby",
    "color": "Red",
    "carat": 1.5
}"#);

Throw (Persist Data)

Send a pebble to MySQL for long-term storage.

vault.throw("gem", "my_precious_pebble");

Drop (Delete Data)

Remove a pebble from memory or disk.

vault.drop("gem", "my_precious_pebble");

Skim (Read Data)

Retrieve a pebble from memory or disk.

let data = vault.skim("gem", "my_precious_pebble");

PebbleStack (Create Table)

Create a new table (or collection) of pebbles.

vault.pebblestack("gem", "my_pebble_stack");

PebbleDump (Bulk Insert)

Add multiple pebbles at once.

let data1 = r#"{
    "name": "Sapphire",
    "color": "Blue",
    "carat": 2.5
}"#;

let data2 = r#"{
    "name": "Emerald",
    "color": "Green",
    "carat": 1.8
}"#;

let data3 = r#"{
    "name": "Topaz",
    "color": "Yellow",
    "carat": 3.0
}"#;

vault.pebbledump("gem", "my_pebble_stack", vec![data1, data2, data3]);

PebbleShift (Update Data)

Update an existing pebble's data.

vault.pebbleshift("gem", "my_precious_pebble", r#"{
    "carat": 2.0
}"#);

PebbleSift (Query Data)

Filter and find specific pebbles.

let results = vault.pebblesift("gem", "my_pebble_stack", r#"{
    "color": "Red"
}"#);

PebblePatch (Patch Data)

Partially update a pebble's data.

vault.pebblepatch("gem", "my_precious_pebble", r#"{
    "color": "Deep Red"
}"#);

PebbleFlow (Transaction)

Ensure atomic operations.

vault.pebbleflow(|txn| {
    txn.collect("gem", "pebble1", data1);
    txn.collect("gem", "pebble2", data2);
    txn.throw("gem", "pebble1");
    txn.drop("gem", "pebble2");
});

PebbleSquash (Delete Table)

Remove an entire table (or collection) of pebbles.

vault.pebblesquash("gem", "my_pebble_stack");

Installation 🛠️

To get started with PebbleVault, just run:

cargo install pebblevault

Example Usage

use pebblevault::Vault;

let vault = Vault::new();

// Define a class of pebbles
vault.define_class("gem", r#"{
    "name": "string",
    "color": "string",
    "carat": "float"
}"#);

// Create a new table (or collection) of pebbles
vault.pebblestack("gem", "my_pebble_stack");

// Insert data into the vault
vault.collect("gem", "my_precious_pebble", r#"{
    "name": "Ruby",
    "color": "Red",
    "carat": 1.5
}"#);

// Bulk insert multiple pebbles
vault.pebbledump("gem", "my_pebble_stack", vec![data1, data2, data3]);

// Query the vault to find specific pebbles
let results = vault.pebblesift("gem", "my_pebble_stack", r#"{
    "color": "Red"
}"#);

// Update an existing pebble's data
vault.pebbleshift("gem", "my_precious_pebble", r#"{
    "carat": 2.0
}"#);

// Partially update a pebble's data
vault.pebblepatch("gem", "my_precious_pebble", r#"{
    "color": "Deep Red"
}"#);

// Retrieve data from the vault
let data = vault.skim("gem", "my_precious_pebble");

// Persist data to MySQL
vault.throw("gem", "my_precious_pebble");

// Remove data from the vault
vault.drop("gem", "my_precious_pebble");

// Ensure atomic operations with a transaction
vault.pebbleflow(|txn| {
    txn.collect("gem", "pebble1", data1);
    txn.collect("gem", "pebble2", data2);
    txn.throw("gem", "pebble1");
    txn.drop("gem", "pebble2");
});

// Delete an entire table (or collection) of pebbles
vault.pebblesquash("gem", "my_pebble_stack");

Contribute 🤝

Do you have ideas to make PebbleVault even better? Want to add more fun to our pebble party? Join us in making PebbleVault the best place for all your pebble-keeping needs! Check out our contributing guide and start throwing your ideas our way.

License 📜

PebbleVault is licensed under the Apache 2.0 License. Rock on! 🤘