Edit on GitHub

JsonDB

Build Status

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

Example

julia> using JsonDB

julia> const d = JsonDB

julia> db = d.load("test.db", false)
Main.JsonDB.Database(Dict{Any,Any}(), nothing, "test.db", false)

julia> d.set(db, "fizz", "buzz")
true

julia> d.get(db, "fizz")
"buzz"

julia> d.dump(db)
true

Index

Functions

JsonDB.Database — Type

JsonDB.Database

This type holds instance of database

Base.haskey — Method

Base.haskey(db::Database, key)

Returns true if key is present in the database else returns false

Base.length — Function

Base.length(db::Database, name=nothing)

Returns total number of key/value pairs in the database if name is nothing else returns length of the value with key name

JsonDB.append — Method

JsonDB.append(db::Database, key, more)

Adds more to keys's value

JsonDB.append — Method

JsonDB.append(db::Database, name::String, pos::Integer, more)

Appends more to value at index pos in array with label name

JsonDB.append_array — Method

JsonDB.append_array(db::Database, name::String, seq)

Appends more to the array with label name

JsonDB.create_array — Method

JsonDB.create_array(db::Database, name::String)

Create an array as key with label name

JsonDB.create_dict — Method

JsonDB.create_dict(db::Database, name::String)

Creates a dictionary with label name

JsonDB.delete — Method

JsonDB.delete(db::Database, key)

Deletes key from the database

JsonDB.delete_array — Method

JsonDB.delete_array(db::Database, name::String)

Deletes array with key/label name from the database

JsonDB.delete_dict — Method

JsonDB.delete_dict(db::Database, name::String)

Deletes dictionary with label name and all of its keys

JsonDB.delete_value — Method

JsonDB.delete_value(db::Database, name::String, value)

Deletes value from array with label name

JsonDB.deletedb — Method

JsonDB.deletedb(db::Database)

Deletes everyhing from the database db

JsonDB.dump — Method

JsonDB.dump(db::Database)

Force dump databse to memory

JsonDB.get — Method

JsonDB.get(db::Database, key)

Get value of the key

JsonDB.get — Method

JsonDB.get(db::Database, name::String, pos::Integer)

Returns value at pos from an array with label name

JsonDB.getall — Method

JsonDB.getall(db::Database)

Returns iterator over all keys in the database

JsonDB.haskey — Method

JsonDB.haskey(db::Database, name::String, key)

Checks whether key is in dictionary with label name

JsonDB.hasvalue — Method

JsonDB.hasvalue(db::Database, name::String, value)

Returns true if value is present in array with label name else returns false

JsonDB.keys — Method

JsonDB.keys(db::Database, name::String)

Returns iterator over all the keys in dictionary with label name

JsonDB.load — Function

JsonDB.load(path::String, auto_dump::Bool)

Returns a Database object which is stored at path. Flag auto_dump determines whether to dump the databse to disk after every set(write), update and delete operation.

JsonDB.merge — Method

JsonDB.merge(db::Database, name1::String, name2::String)

Merge the dictionary with label name2 into the dictionary with label name1. See the documentation for [Base.merge](https://docs.julialang.org/en/v1/base/collections/#Base.merge)

JsonDB.pop — Method

JsonDB.pop(db::Database, name::String, pos)

In case of array deletes the value at index posfrom array with label name In case of dictionary deletes the value with key pos from dictionary with label name

JsonDB.range — Method

JsonDB.range(db::Database, name::String, _start, _end)

Returns slice from array with label name with starting index _start and ending index _end

JsonDB.set — Method

JsonDB.set(db::Database, key, value)

Insert key-value pair into the database

JsonDB.set_array — Method

JsonDB.set_array(db::Database, name::String, value)

Adds value to array with label name

JsonDB.set_dict — Method

JsonDB.set_dict(db::Database, name::String, pair)

Adds a key/value pair to dictionary with label name. pair can be an array or tuple of length 2

JsonDB.values — Method

`JsonDB.values(db::Database, name::String)

Returns iterator over all the values in dictionary with label name