tablestg 0.4.1

pub use atom_file::Data;
use std::hash::Hash;
use std::sync::Arc;

/// Value for Hash Map lookup.
pub trait SmallFixed {
    fn size() -> usize;
    fn load(bytes: &[u8]) -> Self;
    fn save(&self, bytes: &mut [u8]);
}

/// Key for Hash Map lookup.
pub trait Key<T> : Hash
where
    T: SmallFixed,
{
    /// Check that hash lookup has found correct value.
    fn ok(&self, v: &T, ps: &mut PageSet) -> bool;
}

/// [PageSet] - keeps track of changed pages that need saving.
pub mod pageset;
pub use pageset::*;

/// [HashMap] - maps keys to values using 64 bit hash.
pub mod hashmap;
pub use hashmap::*;

/// [Table] -- fixed size record storage. Divided into pages, each page stores up to 64 records.
pub mod table;
pub use table::*;

/// [VarValAddr] and [IdAndVVAddr] -- storage of variable length values.
pub mod varval;
pub use varval::*;

// Private modules.

/// [PageTree] - list of pages implemented as tree.
mod pagetree;
use pagetree::*;

/// [TreeVec] -- a variable length list of bytes. Used to implement [Table].
mod treevec;
use treevec::*;

/// Hash Map Bucket - maps keys to values using 64 bit hash.
mod bucket;

const PAGE_SIZE: u64 = 4612;
// pub const PAGE_SIZE: u64 =  4612;

#[test]
fn test_main() {
    use page_store::*;

    let limits = Limits::default();
    /*
    let _dt = DataType::String{};
    let _dt = DataType::Binary{};
    let _dt = DataType::Int(4);
    let _dt = DataType::Array( 5, Box::new(DataType::String) );
    let _dt = DataType::Map( Box::new(DataType::String), Box::new(DataType::String) );
    let _dt = DataType::Struct( Vec::new() );
    */

    // Construct BlockPageStg.
    let file = atom_file::MultiFileStorage::new("test.db");
    let upd = atom_file::FastFileStorage::new("test.upd");
    let af = atom_file::AtomicFile::new_with_limits(file, upd, &limits.af_lim);
    let ps = BlockPageStg::new(af, &limits);
    let is_new = ps.is_new();

    let spd = SharedPagedData::new_from_ps(ps);

    println!("max page size={}", spd.psi.max_size_page());

    let mut ps = PageSet::new(spd.new_writer());

    if false {
        let (root, len) = if is_new { (ps.new_page(), 0) } else { (3, 410) };
        test_tv(root, len, &mut ps);
    }

    if false {
        println!("Calling test_hash");
        hashmap::test_hash(&mut ps);
    }

    if false {
        test_table(&mut ps);
    }

    if false {
        test_varval(&mut ps);
    }

    test_cust(&mut ps);

    // ps.save();

    spd.shutdown();
}

#[cfg(test)]
fn tos(s: &[u8]) -> &str {
    str::from_utf8(s).unwrap()
}

/*
   For a table with very fragmented ids, you can make a new table with new compact ids, and map the old ids to the new ones using a PagedHashMap.

   Access is slightly slower, due to the extra Hash lookup.
*/

#[derive(serde::Serialize, serde::Deserialize, Clone, Hash, PartialEq, Eq, Debug)]
/// Not yet in use.
pub enum DataType {
    /// e.g. date
    Named(u64),

    /// e.g. `struct{ name: string, email: string, created: date }`
    Struct(Vec<(String, DataType)>),

    /// e.g. `( string, string, int )`
    Tuple(Vec<DataType>),

    /// e.g. `enum{ leaf: int, node: [int] }`
    Enum(Vec<(String, DataType)>),

    /// e.g. `string`
    String(u8),

    /// e.g. `binary(50)` - 50 is the number of bytes stored inline.
    Binary(u8),

    /// e.g. `int`
    Int(u8),

    /// e.g. `[string; 5]`
    Array(usize, Box<DataType>),

    /// e.g. `[string]`
    List(Box<DataType>),

    /// e.g. `[string->int]`
    Map(Box<DataType>, Box<DataType>),
}

impl DataType {
    pub fn to_bytes(&self) -> Vec<u8> {
        postcard::to_stdvec(self).unwrap()
    }
    pub fn from_bytes(b: &[u8]) -> Self {
        postcard::from_bytes(b).unwrap()
    }
}

use pstd::localalloc::Local;
/// `StringA<Local>`
pub type LString = pstd::StringA<Local>;
/// `VecA<T, Local>`
pub type LVec<T> = pstd::VecA<T, Local>;

#[derive(serde::Serialize, serde::Deserialize, Clone, Hash, PartialEq, Eq, Debug)]
/// Generic value.
pub enum Value {
    Int(i64),
    String(LString),
    Binary(LVec<u8>),
    List(LVec<Value>),
    VarVal(u64, u64),
    IList(LVec<i64>),
}

impl Value {
    pub fn to_bytes(&self) -> Vec<u8> {
        postcard::to_stdvec(self).unwrap()
    }
    pub fn from_bytes(b: &[u8]) -> Self {
        postcard::from_bytes(b).unwrap()
    }

    pub fn list(&mut self) -> &mut LVec<Value>
    {
        match self {
            Value::List(list) => list,
            _ => panic!()
        }
    }

    pub fn ilist(&mut self) -> &mut LVec<i64>
    {
        match self {
            Value::IList(list) => list,
            _ => panic!()
        }
    }

    pub fn string(&self) -> &LString
    {
        match self {
            Value::String(s) => s,
            _ => panic!()
        }
    }

    pub fn int(&self) -> i64
    {
        match self {
            Value::Int(x) => *x,
            _ => panic!()
        }
    }
}

#[test]
fn test_value() {
    /*
        use pstd::veca;
        let v1 = Value::List(veca![
            Value::String(LString::from("George Barwood")),
            Value::String(LString::from("george.barwood@gmail.com")),
            Value::String(LString::from("33 Sandpipe Close, GL2 4LZ")),
            Value::Int(-47),
            Value::Int(99),
            Value::VarVal(100, 20),
            Value::IList(veca![1, 2, 3, 4]),
        ]);
        let bytes = v1.to_bytes();
        println!("len={} bytes={:?}", bytes.len(), bytes);

        let v2 = Value::from_bytes(&bytes);
        println!("v2={:?}", v2);
    */
}

#[test]
fn test_datatype() {
    let t1 = DataType::String(20);
    let t2 = DataType::Int(3);
    let t3 = DataType::Struct(vec![
        ("name".to_string(), t1.clone()),
        ("email".to_string(), t1.clone()),
    ]);
    let t4 = DataType::Tuple(vec![t1, t2, t3]);

    let bytes = t4.to_bytes();
    // println!("bytes={:?}", bytes);

    let t5 = DataType::from_bytes(&bytes);
    // println!("t5={:?}", t5);
    assert_eq!(t5, t4);
}

/* System tables.

   VarVal tables with diffent chunk sizes.
   Schema table
     Name : string
   Table table
     Schema, Name, DataType (varval), root/len, next_id

   DataType table
     Schema, Name, DataType (varval)

   Function table
     Schema, Name, Definition (varval)
*/

/* Next: make test that stores customer records, Name, Email, Created in a table.
   Then scans them.
*/

#[cfg(test)]
#[derive(Hash)]
struct CustEmailKey<'a> {
    email: &'a str,
}

#[cfg(test)]
impl <'a> Key<VarValAddr> for CustEmailKey<'a> {
    fn ok(&self, v: &VarValAddr, ps: &mut PageSet) -> bool {

        // First get the list of ids.
        let mut list = v.get_value( ps );
        
        // Now check the email of first element in the list.
        let key = list.ilist()[0];

        // Use the HashMap to retrieve the varval address.
        let hms = ps.cust_hashmap;
        let mut hm = HashMap::restore( hms, ps );
        let addr = hm.get(&key).unwrap();

        // Use the address to retrieve the customer record.
        let mut cr = addr.get_value( ps );

        // Check the email address in the customer data matches self.email
        let email = cr.list()[2].string();

        *self.email == **email
    }
}

#[cfg(test)]
fn init(ps: &mut PageSet)
{
    let hm = HashMap::<IdAndVVAddr>::new(ps, 1);
    ps.cust_hashmap = hm.save();

    let hm = HashMap::<VarValAddr>::new(ps, 1);
    ps.cust_by_email = hm.save();
}

#[cfg(test)]
fn make_cust(ps: &mut PageSet, rid: i64, name: &str, email: &str, postal: &str)
{
    use pstd::veca;

    // Set up a customer record in memory.
    let cr = Value::List(veca![
        Value::Int(rid), // Doesn't need to be stored here.
        Value::String(LString::from(name)),
        Value::String(LString::from(email)),
        Value::String(LString::from(postal)),
    ]);

    // Store the customer record ( which has variable length ).
    let addr = VarValAddr::new( &cr, ps );
    
    {
        // Insert into cust_hashmap.
        let mut hm = HashMap::restore( ps.cust_hashmap, ps );
        
        let val = IdAndVVAddr{ rid, addr };

        hm.insert(&rid, val);
        
        if hm.root_changed() { ps.cust_hashmap = hm.save(); }
    }

    let emkey = CustEmailKey { email };

    // Get the address of list of ids.
    let addr = 
    { 
        let mut hm = HashMap::restore( ps.cust_by_email, ps );
        let addr = hm.remove(&emkey);
        if hm.root_changed() { ps.cust_by_email = hm.save(); }
        addr
    };

    let addr = if let Some(addr) = addr
    {
        // List already exists, append to it.
        let mut list = addr.get_value(ps);   
        list.ilist().push( rid );
        addr.update_value(&list, ps)
        
    } else { 
        // Create list with single element and store it as VarVal.
        let list = Value::IList(veca![rid]);
        VarValAddr::new( &list, ps )
    };

    // Associate addr with emkey.
    let mut hm = HashMap::restore( ps.cust_by_email, ps );
    hm.insert(&emkey, addr);
    if hm.root_changed() { ps.cust_by_email= hm.save(); }
}

#[cfg(test)]
fn list_cust(ps: &mut PageSet, email: &str)
{
    // Get set of customer ids with specified email address.

    let key = CustEmailKey { email };
    let mut hm = HashMap::restore( ps.cust_by_email, ps );
    
    if let Some(addr) = hm.get( &key )
    {
        let list = addr.get_value(ps);
        
        println!( "List of cust ids for {} = {:?}", email, list );
    }
    else
    {
        println!("No cust ids found for email {}", email);
    }
}

#[cfg(test)]
fn test_cust(ps: &mut PageSet) {
    init(ps);
    make_cust(ps, 99, "George Barwood", "george@gmail.com", "33 Sandpipe Close, GL2 4LZ" );
    // Make a duplicate
    make_cust(ps, 100, "George Barwood", "george@gmail.com", "33 Sandpipe Close, GL2 4LZ" );
    // Another duplicate
    make_cust(ps, 101, "George Barwood", "george@gmail.com", "33 Sandpipe Close, GL2 4LZ" );
    
    make_cust(ps, 102, "Marilyn Barwood", "maz.barwood@gmail.com", "33 Sandpipe Close, GL2 4LZ" );

    list_cust(ps, "george@gmail.com" );
    list_cust(ps, "maz.barwood@gmail.com" );
    list_cust(ps, "mary@gmail.com" );
}