DB

Documentation for DB package

Connect to Database

You can use connect function to connect to database, connect returns an object with these fields:

• createTable
• removeTable
• getModel

Connect requires an object as parameter which has these fields

• client: name of DBMS Client like: mysql, pg, sqlite3, .....
• host: database host like: localhost
• user: database username
• password: database password
• database: database name
• filename: filename for sqlite3 database, :memory:, test.db, ....

Create Table

To create new table you need to use createTable function, like this:

        import {connect} from '@ulibs/db'

        const {createTable} = connect({client: 'sqlite3', filename: ':memory:'})

        await createTable("users", {
            name: 'string|required',
            email: 'string',
            username: 'string|unique',
            age: 'number',
        })

        //with references

        await createTable("tasks", {
            name: 'string|required',
            user_id: 'number|reference=users'
          })

        // createTable automatically adds 'id' field to all tables.
    

create Model

to create a model you can use this code:

        const {createTable, getModel} = connect({...})

        // createTable(...)


        const Users = getModel('users')

        // then you can use methods of model on User object
    

• query: to get list of rows. supports filter, pagination and sort.
• get: return single object based on id.
• insert: insert new data to the table.
• update: updates a row, requires id of the row and object.
• remove: remove a row based on id