Merge pull request #148 from JakeRoggenbuck/env-logging

Add logging

Author: JakeRoggenbuck

Cargo.lock

@@ -13,6 +13,8 @@ pyo3 = "0.22.0"
 serde = { version = "1.0.218", features = ["derive"] }
 bincode = "1.3.3"
 serde_json = "1.0.139"
+env_logger = "0.11.6"
+log = "0.4.26"
 
 [dev-dependencies]
 criterion = { version = "0.4", features = ["html_reports"] }

Cargo.toml

@@ -2,7 +2,7 @@
 from lstore.query import Query
 import timeit
 
-counts = [10, 100, 1000, 10_000, 100_000, 1_000_000, 10_000_000]
+counts = [10, 100, 1000, 10_000, 100_000, 1_000_000]
 
 
 def run_inserts(amount: int):

python/benchmarks/scaling_tester.py

@@ -4,6 +4,7 @@ use super::index::RIndex;
 use super::pagerange::PageRange;
 use super::table::{PageDirectory, RTable, RTableMetadata, StatePersistence};
 use crate::table::RTableHandle;
+use log::info;
 use pyo3::prelude::*;
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
@@ -30,10 +31,24 @@ pub struct RDatabase {
     pub buffer_pool: BufferPool,
 }
 
+/// Setup env logging
+///
+/// To use the logger, import the debug, error, or info macro from the log crate
+///
+/// Then you can add the macros to code like debug!("Start database!");
+/// When you go to run the code, you can set the env var RUST_LOG=debug
+/// Docs: https://docs.rs/env_logger/latest/env_logger/
+#[inline]
+fn init_logging() {
+    let _ = env_logger::try_init();
+}
+
 #[pymethods]
 impl RDatabase {
     #[new]
     pub fn new() -> Self {
+        init_logging();
+
         RDatabase {
             tables: vec![],
             tables_hashmap: HashMap::new(),
@@ -74,6 +89,8 @@ impl RDatabase {
             self.tables_hashmap.insert(table.name.clone(), index);
             index += 1;
         }
+
+        info!("Database opened!");
     }
 
     fn close(&self) {
@@ -107,6 +124,8 @@ impl RDatabase {
                 // nothing.
             }
         }
+
+        info!("Database closed!");
     }
 
     pub fn create_table(

src/database.rs

@@ -21,7 +21,6 @@ impl<T: Serialize + for<'de> Deserialize<'de>> WriterStrategy<T> for BinaryFileW
     #[inline(always)]
     fn read_file(&self, path: &str) -> T {
         let file = BufReader::new(File::open(path).expect("Should open file."));
-
         let object: T = bincode::deserialize_from(file).expect("Should deserialize.");
         return object;
     }
@@ -49,6 +48,7 @@ impl<T: Serialize + for<'de> Deserialize<'de>> WriterStrategy<T> for JSONFileWri
     fn read_file(&self, path: &str) -> T {
         let json = read_to_string(path).expect("Should open file.");
         let object: T = serde_json::from_str(&json).expect("Should deserialize.");
+
         return object;
     }
 }