ronolo/json-database

A lightweight JSON document database, which sits on top of ronolo/json-store and adds document relations and query caching.

0.8.1 2019-11-18 22:12 UTC

Requires

• php: >= 7.2
• ext-json: *
• league/flysystem: ^1.0
• ronolo/jsonquery: ^1.1

Requires (Dev)

• league/flysystem-memory: ^1.0
• league/flysystem-ziparchive: ^1.0
• phpunit/phpunit: ^8.4

Suggests

• league/flysystem-cached-adapter: Allows to have a memory/persistent cache like database
• league/flysystem-memory: Allows to have a database in memory
• league/flysystem-ziparchive: Allows to have a single ZIP file as database

MIT

• Ronald Locke

• nosql
• json
• file
• db
• document
• flat

README

This is an on-top sitting extension of ronolo/json-store which adds additional database like features to the JSON document store. Please read https://github.com/RoNoLo/json-store/blob/master/README.md to learn what you can do with it.

This extension adds relation ships between JSON documents.

Usage

$config = Database\Config();
$config->addStore('person', (new Store\Config())->setAdapter(new MemoryAdapter()));
$config->addStore('interests', (new Store\Config())->setAdapter(new MemoryAdapter()));

$database = Database::create($config);

This will tell the database, that it knows 2 JSON stores under the hood and when ever a query against the database will happen the database will look for referenced documents put them in place and return the documents normally.

A Referenced document is one which lives in it own store, but is maybe shared by other store documents. Here an example how it looks under the hood.

$config = Database\Config();

$config->addStore('person', (new Store\Config())->setAdapter(new Local('/foo/bar/persons')));
$config->addStore('interests', (new Store\Config())->setAdapter(new Local('/foo/bar/interests')));
$database = Database::create($config);

// Create a few interests
$hobby1 = $database->put('interests', ['name' => 'Music', 'stars' => 4], true);
$hobby2 = $database->put('interests', ['name' => 'Boxen', 'stars' => 3.4], true);
$hobby3 = $database->put('interests', ['name' => 'Movies', 'stars' => 5], true);

// Create some persons
$person1 = $database->put('person', [
    'name' => 'Ronald',   
    'interests' => [$hobby1, $hobby2]
]);
$person2 = $database->put('person', [
    'name' => 'Ellen',   
    'interests' => [$hobby2, $hobby3]
]);
$person3 = $database->put('person', [
    'name' => 'James',   
    'interests' => []
]);
$person4 = $database->put('person', [
    'name' => 'Katja',   
    'interests' => [$hobby3, $hobby1, $hobby2]
]);

// Request of Katja which will return a JSON object with her 3 hobbies dereferenced.
$katja = $database->read('person', $person4);

Katja as JSON:

{
    "name": "Katja",   
    "interests": [
        {
            "name": "Movies", 
            "stars": 5
        },
        {
            "name": "Music", 
            "stars": 4
        },
        {
            "name": "Boxen", 
            "stars": 3.5
        }
    ]   
}

Goals

• No real database needed like SqlLite, Mysql, MongoDB, CouchDB ...)
• PHP 7.2+
• Document Store aka NoSQL
• JSON as format of storage
• (very) low memory usage even for huge results
• NoSQL like query syntax (CouchDB style)
• Repository and database (document relations) usage options
• Abstract data location via https://flysystem.thephpleague.com/