Light

bartlomieju / rusty_buntdb Goto Github PK

View Code? Open in Web Editor NEW

14.0 3.0 1.0 214 KB

A Rust port of BuntDB

License: MIT License

Rust 100.00%

rust geospatial btree btree-indexes

rusty_buntdb's Introduction

This is a Rust port of fantasitc BuntDB project by Josh Baker.

Big parts of this project are taken directly from BuntDB including API surface and API documentation.

Contributions are welcome and enouraged! Please see "Issues" for ideas for contributions.

rusty_buntdb's People

Contributors

Stargazers

Watchers

Forkers

isgasho

rusty_buntdb's Issues

Port tests

https://github.com/tidwall/buntdb/blob/master/buntdb_test.go

Add remaining index comparison functions

Reference:
https://github.com/tidwall/buntdb/blob/89544ad8fc446ae7c798e487951dc06739092b6b/buntdb.go#L2197-L2245

Special care needs to be taken when considering JSON methods; I believe https://crates.io/crates/gjson doesn't have case-insensitive comparison as of now.

Consider splitting codebase into more modules

Currently all of the code is in src/lib.rs. I did that in an effort to port the Go version as closely as possible. Given that Rust code is a bit more verbose in some situations the file is already at over 2,5k lines.

I believe in the long run it will be beneficial to split the library into multiple modules, it should help spot "non-rusty" code that could be made better after initial port.

Proposed modules:

src/db.rs - Db struct
src/tx.rs - Tx struct
src/index.rs - Index struct
src/error.rs - DbError struct
src/tree_utils.rs - helper functions for traversing BTreeC

String type is used too liberally

Currently most of the methods use String type. This is needlessly expensive and causes a lot of clones or .to_string() calls throughout the codebase.

Most of the occurences should be changed to &str or something along the lines impl String.

I will look into this once most of the tests are passing.

Port "match" package

match is used when matching indexes and should be ported as a utility module matcher.rs (match is a keyword in Rust so it would require prefixing each occurrence with r#).

Research BTree implementation

I did search for crates implementing BTree but found only one crate maintained: https://github.com/nimrodshn/btree

However it's disk-backed and has completely different API than: https://github.com/tidwall/btree

I tried going with BTreeSet and implementing wrapper structs like: OrdByKeyItem and OrdByExpItem but I'm not sure this is a viable path.

Setup CI

Need to add basic CI script, I'll look into that once some tests are ported and passing.

Tx::lock and Tx::unlock don't work

Currently Tx::lock and Tx::unlock are stubbed out:

rusty_buntdb/src/lib.rs

Lines 1246 to 1264 in 29ef544

 // lock locks the database based on the transaction type. 

 fn lock(&self) { 

 // todo!() 

 // if self.writable { 

 // self.db.mu.write().unwrap(); 

 // } else { 

 // self.db.mu.read().unwrap(); 

 // } 

 } 

 // unlock unlocks the database based on the transaction type. 

 fn unlock(&self) { 

 // todo!() 

 // if self.writable { 

 // self.db.mu.unlock(); 

 // } else { 

 // self.db.mu.read_unlock(); 

 // } 

 }

This is fine for now as DB runs on single thread but needs to be fixed prior to making DB multithreaded (#7). Since Rust RwLock return a "guards" that unlock when they are dropped, those guards need to be stored on the Tx struct.

Tx::commit() doesn't properly write to disk

Currently Tx::commit() has a very naive implementation of writing to disk:

rusty_buntdb/src/lib.rs

Lines 1344 to 1352 in 29ef544

 // TODO: handle partial writes 

 let db_file = db.file.as_mut().unwrap(); 

 let sync_policy = db.config.sync_policy.clone(); 

 if let Err(e) = db.file.as_mut().unwrap().write_all(&db.buf) { 

 drop(db); 

 self.rollback_inner(); 

 // TODO: return error 

 }

It should be updated to handle partial writes like Go version does:

https://github.com/tidwall/buntdb/blob/89544ad8fc446ae7c798e487951dc06739092b6b/buntdb.go#L1188-L1211

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.

	// lock locks the database based on the transaction type.
	fn lock(&self) {
	// todo!()
	// if self.writable {
	// self.db.mu.write().unwrap();
	// } else {
	// self.db.mu.read().unwrap();
	// }
	}

	// unlock unlocks the database based on the transaction type.
	fn unlock(&self) {
	// todo!()
	// if self.writable {
	// self.db.mu.unlock();
	// } else {
	// self.db.mu.read_unlock();
	// }
	}

	// TODO: handle partial writes
	let db_file = db.file.as_mut().unwrap();
	let sync_policy = db.config.sync_policy.clone();

	if let Err(e) = db.file.as_mut().unwrap().write_all(&db.buf) {
	drop(db);
	self.rollback_inner();
	// TODO: return error
	}