Install: npm i @sectly-studios/suchdb
| (https://www.npmjs.com/package/@sectly-studios/suchdb)
let SuchDB = require("@sectly-studios/suchdb");
let database = new SuchDB.SuchDB({}); // Make an new database instance
database.set("foo", "bar") // Lets add some data
database.get("foo") // Lets grab the data, It should return: bar
database.set("foo", { bar: [1, 2, 3, 4], baz: { name: "SuchDB" } }) // SuchDB Supports: Strings, Numbers, Objects And Arrays As Values
database.get("foo") // { bar: [1, 2, 3, 4], baz: { name: "SuchDB" } })
database.get("foo").bar // [1, 2, 3, 4]
database.get("foo").bar[0] // 1
database.get("foo").baz // { name: "SuchDB" }
database.get("foo").baz["name"] // SuchDB
- exports
- set
- get
- remove
- clear
- keys
- values
- entries
- forEach
- size
- isEmpty
- has
- lookup
- sort
- save
- load
- raw
- Boot
- Find
- FindMultiple
Browser:
Load in file with:
<script src="path/to/suchdb"></script>
let database = SuchDB.SuchDB();
Node.js:
let SuchDB = require("@sectly-studios/suchdb");
let database = new SuchDB.SuchDB();
let SuchDB = require("@sectly-studios/suchdb").SuchDB({
master: "data",
autosave: true,
autoload: false,
encrypt: {
enabled: true,
key: "SuchDB_Key",
},
autobackup: true,
logging: true,
custom_logging : function(message) {
// Some code to log to something like logtail or sentry.
}
});
Set/Add Data To The Database
key
stringvalue
any
database.get(key, value)
Get/Grab Data From The Database
key
string
database.get(key) // Returns data
Remove/Delete Data From The Database
key
string
database.remove(key)
Clear/Delete All Data In The Database
database.clear()
Get Database Keys
database.keys() // Returns keys
Get Database Values
database.values() // Returns values
Get Database Entries
database.entries() // Returns object
Loop Through All Data In The Database
callback
function (key, value)
database.forEach(function(key, value) {
// Retuns key and value
})
Get Database Size
database.size() // Returns number
Check If Database Is Empty
database.isEmpty() // Returns boolean
Check If Database Has Data
key
database.has(key) // Returns boolean
Lookup Data In The Database
value
any
database.lookup(value) // Returns data
Sort the database
database.sort(key, reverse)
Port Json To The Database
json
anyoverwrite
boolean
database.port(json, overwrite)
Save Database To:
localStorage node-fs
database.save()
Load Database From:
localStorage node-fs
overwrite
boolean
let overwrite = false;
database.load(overwrite)
Save Database Backup To:
localStorage node-fs
database.saveBackup()
Load Database Backup From:
localStorage node-fs
overwrite
boolean
let overwrite = false;
database.loadBackup(overwrite)
Get Raw Database Data
database.raw() // Returns object
Find entry by query
database.find({name:"something",value:"something"}) // Returns entry
Find one or more entries by query
database.findMultiple({name:"something",value:"something"}) //Returns an array of entries
SuchDB
var options = {
master: "data",
autosave: true,
autoload: false,
encrypt: {
enabled: true,
key: "SuchDB_Key",
},
autobackup: true,
};
let database = new SuchDB.SuchDB(options);
let SuchDB = require("@sectly-studios/suchdb");
options
Object
var options = {
master: "data",
autosave: true,
autoload: false,
encrypt: {
enabled: true,
key: "SuchDB_Key",
},
autobackup: true,
};