envdb
v1.1.3
Published
EnvDB is a json database that transfers data by connecting via remote APIs and can store data as json in .env
Downloads
45
Maintainers
Readme
EnvDB English
EnvyDB is a database module that encodes data in base64 and UTF-32 formats, stores it in .env
and returns it in JSON format. This documentation explains how to use the functions that EnvyDB provides.
Definitions
import { envdbServer, envdbClient } from "envdb"; // ES6 Modules
const { envdbServer, envdbClient } = require("envdb"); // CommonJS
Transferring everything in QuickDB to EnvDB
const db = new envdbClient({
baseURL: "https://example.com",
username: "username",
password: "password"
});
const quickdb = require("quick.db");
await db.move(quickdb)
Functions
await envdbServer(port, username, password);
const db = new envdbClient({ baseURL: "https://example.com", username: "admin", password: "password"});
await db.start();
await db.ping(); // return as integer/ms
db.set(path, value)
Assigns a value (value
) to the specified path (path
).
Parameters:
path
(string/integer): The path to assign the value to.value
(any): The value to assign to the path.
Example Usage:
await db.set('x.y.z', 'abc');
// Assigns the value 'abc' to the path 'x.y.z'.
await db.add("number", 10);
// If the value in the data is a number, it increases the number with the value you give.
const value = await db.get('x.y.z');
console.log(value); // 'abc'
const data = await db.fetch('x');
console.log(data); // { y: { z: 'abc' } }
const allData = await db.all();
console.log(allData); // Returns the entire database in JSON format
await db.push('a', 'hello');
await db.push('a', 'world');
const data = await db.get('a');
console.log(data); // ['hello', 'world']
await db.unpush('a', 'hello');
const data = await db.get('a');
console.log(data); // ['world']
await db.delByPriority('b', 1);
const data = await db.get('b');
console.log(data); // [{test2: "envdb2"}]
await db.setByPriority('b', {newtest: "hey this is edited"}, 1);
const data = await db.get('b');
console.log(data); // [{newtest: "hey this is edited"}]
const exists = await db.has('x');
console.log(exists); // true or false
await db.delete('x');
const data = await db.get('x');
console.log(data); // undefined or error
await db.deleteAll();
const allData = await db.all();
console.log(allData); // {}
EnvDB Türkçe
EnvyDB, verileri base64 ve UTF-32 formatlarında şifreleyerek .env
dosyasına kaydeden ve JSON formatında geri döndüren bir veritabanı modülüdür. Bu dökümantasyon, EnvyDB'nin sağladığı fonksiyonları nasıl kullanacağınızı açıklamaktadır.
Tanımlar
import { envdbServer, envdbClient } from "envdb"; // ES6 Modules
const { envdbServer, envdbClient } = require("envdb"); // CommonJS
QuickDB içerisinde bulunan herşeyi EnvDB aktarma
const db = new envdbClient({
baseURL: "https://example.com",
username: "username",
password: "password"
});
const quickdb = require("quick.db");
await db.move(quickdb)
Fonksiyonlar
await envdbServer(port, username, password);
const db = new envdbClient({ baseURL: "https://example.com", username: "admin", password: "password"})
await db.start();
await db.ping(); // milisaniye cinsinden xxx sayı olarak döner
db.set(yol, veri)
Belirtilen yola (yol
) bir değer (veri
) atar.
Parametreler:
yol
(yazı/rakam): Değerin atanacağı yol.veri
(herşey): Yola atanacak değer.
Örnek Kullanım:
await db.set('x.y.z', 'abc');
// 'x.y.z' yoluna 'abc' değeri atanır.
await db.add("number", 10);
// Verilerdeki değer eğer bir sayı ise sayıyı sizin verdiğiniz değer ile arttırır
const value = await db.get('x.y.z');
console.log(value); // 'abc'
const data = await db.fetch('x');
console.log(data); // { y: { z: 'abc' } }
const allData = await db.all();
console.log(allData); // Tüm veritabanını JSON formatında döner
await db.push('a', 'hello');
await db.push('a', 'world');
const data = await db.get('a');
console.log(data); // ['hello', 'world']
await db.unpush('a', 'hello');
const data = await db.get('a');
console.log(data); // ['world']
await db.delByPriority('b', 1);
const data = await db.get('b');
console.log(data); // [{test2: "envdb2"}]
await db.setByPriority('b', {newtest:"hey this is edited"}, 1);
const data = await db.get('b');
console.log(data); // [{newtest:"hey this is edited"}]
const exists = await db.has('x');
console.log(exists); // true veya false
await db.delete('x');
const data = await db.get('x');
console.log(data); // undefined veya hata
await db.deleteAll();
const allData = await db.all();
console.log(allData); // {}