Quick Demo

+

Basic Demo

Saving Data

You have many options to save data. As Goblin is a key/value database you need to know what is the key that you want to use/create.

• set(key, data). Write or replace data to a defined key (optional)
• push(data). Write data in a new key (random name added, like MewhnDIutVhm3hulgTaAJj6Utb47GOwe)
• update(data, key). Add and modify data to a defined key

Retrieving Data

By default Goblin will create an empty json file as database storage, if the file exist it will added to Goblin.

• get(key). return all data or data from a defined key (optional)

Remove Data

By default Goblin will create an empty json file as database storage, if the file exist it will added to Goblin.

• delete(key). Remove data from a defined key
• truncate(data). Dump the database

The event will return an object that contains previous data and current data. At the moment the the listeners can be added only to the database root

You can specify the trigger event:

• add
• update
• delete
• reconfigure
• change (always it will be triggered)

You can use events in order to react to changes in the database. All the events are managed internally by Goblin inside as hooks.

We added .on() & .off() methods to manage the events.

You can store also anonymous functions in GoblinDB, we call this functions Ambush.

Once you add Ambush functions to GoblinDB... the system will save them under a .goblin file.

This feature will allow you to bring your functions together with your data to a new projects.

You can perform few basic operations to ambush functions through Goblin specific methods (similar to data ones...).  

• add()
• update()
• remove()
• run()
• details()
• list()

All the ambush functions has an specific setup. Internally they are objects with specific methods and properties

• id, this reference must be unique and also a string.
• description, this will add additional information about the current ambush function (opt & string)
• category, this array will help us to filter our ambush functions.
• action, this is the key feature. This method can be executed from GoblinDB on demand. Only two optional parameters are acepted: arguments (no specific data type) and callback (function).

#AireMAD

•  Support to chain methods. Issue 50
•  Add Pugins system. Issue 12
•  Plugin documentation example. Issue 56
•  Add basic query methods as a plugin. Issue 54
•  Add Avance query methods as a plugin. Issue 55
•  Add support to .once() method for events. Issue 51
•  Add support to UID in events. Issue 53
•  Add additional support to Backup Goblin with other databases like Firebase, Mongo... in real time as a plugin. Issue 52

Contribute

@GoglinDB

slack.osweekends.com

#GoblinDB

https://github.com/GoblinDBRocks

https://github.com/GoblinDBRocks/GoblinDB