#key-value-store #db #kv #database

pickledb

A lightweight and simple key-value store written in Rust, heavily inspired by Python's PickleDB (https://pythonhosted.org/pickleDB/)

7 releases (4 breaking)

0.5.1 Apr 26, 2022
0.5.0 Apr 20, 2022
0.4.1 Mar 29, 2020
0.4.0 May 15, 2019
0.1.0 Jan 16, 2019

#32 in Database implementations

Download history 3515/week @ 2023-11-20 6516/week @ 2023-11-27 5971/week @ 2023-12-04 6748/week @ 2023-12-11 6635/week @ 2023-12-18 2153/week @ 2023-12-25 5808/week @ 2024-01-01 7897/week @ 2024-01-08 7418/week @ 2024-01-15 9308/week @ 2024-01-22 6341/week @ 2024-01-29 8287/week @ 2024-02-05 5026/week @ 2024-02-12 8484/week @ 2024-02-19 8371/week @ 2024-02-26 7520/week @ 2024-03-04

29,806 downloads per month
Used in 20 crates (19 directly)

MIT license

79KB
887 lines

PickleDB

Rust test Rust audit Crate API

PickleDB is a lightweight and simple key-value store written in Rust, heavily inspired by Python's PickleDB

PickleDB is fun and easy to use

use pickledb::{PickleDb, PickleDbDumpPolicy, SerializationMethod};

fn main() {

    // create a new DB with AutoDump (meaning every change is written to the file)
    // and with Json serialization (meaning DB will be dumped to file as a Json object)
    let mut db = PickleDb::new("example.db", PickleDbDumpPolicy::AutoDump, SerializationMethod::Json);

    // set the value 100 to the key 'key1'
    db.set("key1", &100).unwrap();

    // print the value of key1
    println!("The value of key1 is: {}", db.get::<i32>("key1").unwrap());

    // load the DB from the same file
    let db2 = PickleDb::load("example.db", PickleDbDumpPolicy::DumpUponRequest, SerializationMethod::Json).unwrap();

    // print the value of key1
    println!("The value of key1 as loaded from file is: {}", db2.get::<i32>("key1").unwrap());
}

Installation

This crate works with Cargo and can be found in crates.io Add this to your Cargo.toml:

[dependencies]
pickledb = "0.5.1"

Documentation

All documentation for this crate can be found in docs.rs

Examples

There are currently two examples shipped with PickleDB:

  • Hello World which shows the basic usage of PickleDB: create a new DB, load a DB from file, get/set key-value pairs of different types, and more
  • Lists which shows how to use lists in PickleDB: create new lists, add/remove items from lists, retrieve items from lists, remove lists, and more

Changelog

Version 0.5.1

  • Bugfix: Add missing JSON feature gate

Version 0.5.0

  • Turn on/off file formats with features
  • DumpUponRequest policy no longer dumps on Drop
  • (internal) Switch CI from TravisCI to GitHub Actions

Version 0.4.1

  • Bump up dependencies versions to fix vulnerabilities found in few of them

Version 0.4.0

  • Changed all doc tests from ignore to no_run so generated docs don't contain untested warnings
  • Changed both instances of lextend to take iterators of references rather than a slice of values
  • Fixed bug in load_test()
  • Fixed rustfmt and clippy warnings
  • Added examples to Cargo.toml to allow them to be run via Cargo

Version 0.3.0

  • Added new serialization options. Now PickleDB supports JSON, Bincode, YAML and CBOR serializations
  • Added proper error handling (Issue #3)
  • Use Path and PathBuf instead of strings to describe DB paths
  • Better organization of the code

Version 0.2.0

Dependencies

~0.5–1.5MB
~35K SLoC