KoDB

YAML based nosql database library.

Usage

---

Grab the latest version in dist unpack and run...

python setup.py install

Using the DB

To initalize or open a database, it's as straightforward as calling the KoDB class.

db = kodb.KoDB("ko-test.db") # Safely loads the database. (load_type="safe_load")
db = kodb.KoDB("ko-test.db", load_type="load") # Serializes all of the objects in the database.
NOTE: Ko-DB will raise an exception if the document loaded contains unsafe objects.

The Database can be used as is since the database object is the default table. By adding the load_type="load" option, this allows KoDB to load and store serialized python objects. Note: You cannot safe_load a database that has object serialization enabled

Data Storage

data = 	{
	    "title": "delectus aut autem",
	    "completed": False
	  	}
db.store("todo_1", data)	

This stores the data with todo_1 as the Document ID.

Tables can be created by calling the .table function.

my_table = db.table("mytable")
my_table.store("kampraaf", {"type": "wooden table", "price": {"value": 150, "currency": "EUR"}})

Retrieval

There are multiple ways of accessing data.

# returns the document with the todo_1 id
db.get("todo_1")

# returns documents that matches the lambda expression.
my_table.query(lambda x: x.price["value"] > 500) 

# Returns a list generator that returns all of the table's items.
db.get_all()

Others

# Returns a list of a table's IDs.
my_table.items()

# Retuns a list of the database's tables.
db.tables()

# Checks if a document exists.
db.exits("todo_1")

# Commit the database to the file.
db.commit()

# Closes the Database.
db.close

See: test.py for more use cases.

Todo

- Commit History
- Dropping of tables
- Clean and Rebuilding of tables