dk-db v0.1.3

DK-db

DK database - library for working with database.

Examples

| Used code: TypeScript

db_new

Connect in server and make / update record

Ex_1

import {err_is, Err_s, err_throw} from "dk-err";
import {num_1u, num_new} from "dk-num";
import {str_make, str_new} from "dk-str";
import {Db_s, db_table, Db_table, db_table_rec, db_tables} from "./main";
import {db_new} from "./new";

export const main = () => {
    // make pointer DB connection (create the database manually)

    const db: Db_s = db_new({
        name: str_make("test"),
    }); // DB connected true - 80 ms (mysql://root:***@localhost/test)

    // make pointer Table

    const table: Db_table = db_table(db, {
        name    : str_make("table_example"),
        uniqueLs: [
            str_new(num_1u(1, 2), "unique", "unique_2"),
        ],
        fields  : [
            {
                name: str_make("unique"),
                type: str_make("integer"),
                size: num_1u(1, 4),
            }, {
                name: str_make("unique_2"),
                type: str_make("integer"),
                size: num_1u(1, 4),
            }, {
                name: str_make("data"),
                type: str_make("text"),
                size: num_new(2, 1, 20000), // varchar(20000)
            },
        ],
    });

    // create all tables

    const err: Err_s = db_tables(db);

    if (err !== undefined) {
        err_throw(err);
    }

    // record create

    const rec_1 = db_table_rec(table, [
        {
            name: str_make("data"),
            val : str_make("Record data"),
        }, {
            name: str_make("unique"),
            val : str_make("1"),
        }, {
            name: str_make("unique_2"),
            val : str_make("1"),
        },
    ]);

    // check error

    if (err_is(rec_1)) {
        err_throw(rec_1); // throw
    }

    // record update

    const rec_2 = db_table_rec(table, [
        {
            name: str_make("id"),
            val : str_make("1"),
        }, {
            name: str_make("data"),
            val : str_make("Record update2"),
        }, {
            name: str_make("unique"),
            val : str_make("2"),
        },
    ]);

    // check error

    if (err_is(rec_2)) {
        err_throw(rec_2);
    }

    // Print id records

    console.log(
        "rec_1.id = %s, rec_2.id = %s", rec_1.id, rec_2.id,
    ); // rec_1.id = 1, rec_2.id = 1
};

main();

Api

Types

Db

Db_o

Db_s

Table

Db_table_opt

Db_table

Db_table_ls_unique => Array<Str_s>

List unique group (Str_s)

Db_tables => Array<Db_table>

List Db_table

Field

Db_field

Db_fields => Array<Db_field>

Constants

Default library

Connection default

Record default

Find default

Fields

Table

Functions

db_new(opt: Db_o): Db_s

Create new structure Db_s and connection with server

db_table(db: Db_s, opt: Db_table_opt): Db_table

Create new table model by fields

db_tables(db: Db_s):void

Create tables if they do not exist

db_table_rec(table: Db_table, data: Db_fields)

Get / make record in table

db_table_find(table: Db_table, filter: any, offset: Num_s):Array

Search records in table

| filter - orm filter (where)

About

Notes

• Start of development: 2018-10-18 07:50
• This project adheres to Semantic Versioning
• This project used Node-ORM

License

MIT