Informations
What is it ?
KeychainDB is a key-value database for Node.js applications. In other words, you can store data as a key and a value. Data is stored in RAM for maximum speed. The database is local, for minimum latency and maximum security. With its modular architecture, it's easy to add new functionalities using addons, enabling you to customize the database to your needs and add new features.
Main Documentation
Installation
The installation of KeychainDB is pretty simple, you can install it with npm using the following command :
npm install keychaindbImportation and loading
Before being able to use your database, you have to import the module and initialize an instance of the database class.
const { Database } = require("keychaindb");
const db = new Database();Saving a value
To save a value within your database, you need to use the "set" method. You will need to specify a key, a value and a delay in millisecond if you want your value to expire after a given time.
In the following exemple, a variable named "Key" has as value "Value" expire after 5 seconds.
db.set("Key", "Value", 5000);Reading a value
To read a value within your database, you can use the "get" method. You will need to specify a key. You will then get a value.
In the following exemple we are retreiving the value of a saved variable called "Key".
db.get("Key");Deleting a value
To delete a valye within your database, you can use the "delete" method. You will need to specify a key.
In the following exemple, we are delete the value of a key called "Key".
db.delete("Key");Finding a key
To find a value within your database, you can use the "find" method. You will need to specify a way of searching, there is a complete list.
Searching by value
You can search keys by specifying what values they should have. In the following exemple, we are getting every keys that the value is "Value".
db.find("Value");Searching with JSON value
Searching by value also support using JSON to find keys. In the following exemple, we are getting every keys where the name is John and the age is 30.
db.find({ name: "John", age: 30 });Searching with function
Searching with function is a powerful way to find keys. In the following exemple, we are getting every keys where the name is John and the age is higher than 25.
db.find((value) => value.name === "John" && value.age > 25);Searching with regular expression (Regex)
The "find" method support searching with regular expression too. In the following exemple, we are getting every keys that contain the word "Value".
db.find(/Value/);Connecting the database
To connect the database, you need to use the "login" method. This method allow the release of addons's events and make sure of the good behavior of the database.
db.login();