db-avatar-init

1.3.3 • Public • Published



db-viewer

db-viewer is a package of modules. Its main objective is to easily configure and use different databases.

it also includes:

  1. - generate credentials using the command line.

Table of contents

  1. Install
  2. Introduction
  3. Concepts
  4. Examples
  5. Configuration
  6. Test
  7. Help
  8. License

Install

Install with npm:
npm install db-avatar-init

Introduction

db-viewer is a package of modules. Its main objective is to easily configure and use different databases.

Examples

Usage

 
'use strict' 
 
const DBViewer = require('db-avatar-init')
 
const options = {
  dbId: 000000,
  viewName: 'xxxxx.sql',
  user: 'xxxxx',
  password: 'xxxx'
};
 
DBViewer.executeView(options, (error, data) => {
  if(error) {
    console.log(error.message)
  } else {
    console.log(data)
  }
})

Add: in your package.json

"scripts"{
  "init-db": "init-db",
  "init-api": "init-api",
  "server": "node ./.apiserver/index.js"
},

Execute: Create api folder to root path

 npm run init-db

Start: Start server REST API

npm run server

Configuration

Environment Variables: Environment Variables API configuration

Environment variable for Authentication

  • USER_TEMP_API={{username to login}}
  • PASS_TEMP_API={{username passwordto login}}
  • SECRET_PASS_API={{secreat to create token}}

Environment variable app

  • NODE_API_DB_PORT={{application port}}

Test

Test Api rest using command line

Execute: to call api rest

 npm run init-api
Do you want to login? :: [Y, N] : 
 
Enter user body request: {"logonId""XXXXXXX""logonPassword""XXXXXXXXX"}
----------------------------------------------------
 
status 200
 
 What do you want to do? [LIST, INSERT]
 list
----------------------------------------------------------------------------------
[
  {
    id: 1580319420028,
    type'MARIADB',
    connection: {
      id: 12111121,
      database: 'xxxxxxx',
      hostname: 'xxxx',
      port: 'xxxxxx',
      user: 'xxxxxx',
      password: ''
    },
    views: [ [Object] ]
  }
]
 
insert
----------------------------------------------------------------------------------
 
  Enter new DB in json format: 
  ----------------------------------------------------
{ "id": 111111, "type""xxxx""connection"{ "id": 111111,"database""xxxx""hostname""xxxxxx""port""xxxx""user""xxxx" }, "views": [{ "name""xxx.sql""path""views/mariadb/xxx.sql""query""SELECT * FROM xxxxxxx;"}]}
status response:  200

Help

Note: Not all options are currently supported.

License

MIT

Package Sidebar

Install

npm i db-avatar-init

Weekly Downloads

1

Version

1.3.3

License

ISC

Unpacked Size

1.05 MB

Total Files

36

Last publish

Collaborators

  • alex-principe-js