@konsumation/db-level NPM

konsum-db

timeseries database on leveldb

example

import levelup from "levelup";
import leveldown from "leveldown";

import { Master, Category } from "konsum-db";

async function example() {
 // open database
 const db = await levelup(leveldown("example.db"));
 const master = await Master.initialize(db);

 // create category named EV
 const ev = new Category("EV", master, { unit: "kWh" });
 await ev.write(master.db);
 
 // write entry
 await ev.writeValue(db, Date.now(), 77.34);
}

example();

API

LevelCategory

Extends Category

Value Category.

Parameters

name string category name
options Object
- options.description string
- options.unit string physical unit like kWh or m3
- options.fractionalDigits number display precission

Properties

name string category name
description string
unit string physical unit
fractionalDigits number display precission

write

See: {key}

Writes object into database. Leaves all other entries alone.

Parameters

db ClassicLevel

key

Returns string

meters

Get Meters of the category.

Parameters

db ClassicLevel
options Object?
- options.gte string? from name
- options.lte string? up to name
- options.reverse boolean? order

Returns AsyncIterable\

entries

Get categories.

Parameters

db ClassicLevel
gte (string | undefined) lowest name (optional, default "\u0000")
lte (string | undefined) highst name (optional, default "\uFFFF")

Returns AsyncIterable\

MASTER

Prefix of the master record

Type: string

CATEGORY_PREFIX

Prefix of the categories. Will be followed by the category name

Type: string

VALUE_PREFIX

Prefix of the values. Will be followed by the category name

Type: string

METER_PREFIX

Prefix of the meters. Will be followed by the category name

Type: string

NOTE_PREFIX

Prefix of the notes. Will be followed by the category name

Type: string

LevelMaster

Extends Master

Master record. Holds schema version.

Properties

schemaVersion string

write

See: {key}

Writes object into database. Leaves all other entries alone.

Parameters

db ClassicLevel

close

Close the underlaying database.

initialize

Initialize database. checks/writes master record.

Parameters

directory string

Returns Promise\

LevelMeter

Extends Meter

Meter

Parameters

name string meter name
category Category
options Object
- options.description string
- options.unit string physical unit like kWh or m3
- options.fractionalDigits number display precission

Properties

name string category name
description string
unit string physical unit
fractionalDigits number display precission

notes

List assigned Notes.

Parameters

db any
options Object?

Returns AsyncIterable<LevelNote>

values

Get values of the meter.

Parameters

db any
options Object?
- options.gte string? time of earliest value
- options.lte string? time of latest value
- options.reverse boolean? order