kids-db v5.0.1

DB

const { DB } = require(`kids-db`);

Constructor

Инициализация новой инстанции

const db = new DB(DB_Name, options); // => this

Options

Общие опции

Например

new DB(`users`, {
	ttl: 300,
	mode: `BSON`,
});

init

Инициализирует БД

db.init(); // => Promise<true>

statistics

Возвращает текущую статистику для БД

db.statistics(); // => Promise<Object>

save_all_elements_in_mem

Сохраняет все элементы из оперативной памяти, в постоянную память

db.save_all_elements_in_mem(); // => Promise<true>

set_ttl

Сохраняет все элементы из оперативной памяти, в постоянную память

db.set_ttl(ttl); // => Promise<true>

elements

Возвращает обьект с функциями для взаимодействия с элементами БД

db.elements; // => Promise<Object>

get

Возвращает выбранный элемент

db.elements.get(element_id, options); // => Promise<Object>

create

Создает новый элемент

db.elements.create(element_id, data, options); // => Promise<Object>

update

Обновляет выбранный элемент

db.elements.update(element_id, data, options); // => Promise<Object>

save

Сохраняет выбранный элемент

db.elements.save(element_id); // => Promise<true>

delete

Удаляет выбранный элемент

db.elements.delete(element_id); // => Promise<true>

exists

Проверяет существование элемента

db.elements.exists(element_id); // => Promise<boolean>

list

Выводит массив в котором содержатся все идентификаторы существующих элементов

db.elements.list(); // => Promise<Array>

extended_list

Выводит массив в котором содержатся все идентификаторы существующих элементов и дополнительная информация о них

db.elements.extended_list(); // => Promise<Array>

get_selected

Возвращает массив с выбранными элементами

db.elements.get_selected(element_id); // => Promise<Array>

get_all

Возвращает массив со всеми существующими элементами

db.elements.get_all(); // => Promise<Array>

File

load

Инициализация новой инстанции с выбранным элементом

const file = db.load(id, options); // => Promise<this>
//OR
const file = db.create(id, file_data, options); // => Promise<this>

data

Получает данные которые содержатся в выбранном элементе

file.data(); // => Promise<Object>

save

Сохраняет выбранный элемент в постоянную память

file.save(); // => Promise<true>

update

Обновляет выбранный элемент

file.update(new_data); // => Promise<Object>

delete

Навсегда удаляет выбранный элемент с оперативной и постоянной памяти

file.delete(); // => Promise<true>

File_Options

Общие опции

settings

const { setting } = require(`kids-db`);

set_database_dir

Изменяет папку в которой будут храниться данные

settings.set_database_dir(new_dir); // => Promise<true>

set_database_dir

Изменяет путь в котором будет храниться папка с данными

settings.set_database_path(new_path); // => Promise<true>

set_database_dir

Изменяет путь в котором будет храниться папка с данными

settings.set_full_path(new_path); // => Promise<true>

enable_autoclear_cache

Включает автоматическую очистку элементов из оперативной

settings.enable_autoclear_cache(); // => Promise<true>

disable_autoclear_cache

Отключает автоматическую очистку элементов из оперативной

settings.disable_autoclear_cache(); // => Promise<true>