MySQLWrapper

An NodeJS mysql wrapper to convert objects to the full query String! Nice to simplify the work with MySQL in a Node Enviroment

Features

• Handling Database connection
• Create Tables with all around like PK or FK
• Create Database Entrys
• Update Database Entrys
• Delete Database Entrys
• Helps you on handling with timestamps
• Provides a full in memory Caching-System
• Provides a set of callbacks to may log the infos

Usage

Establish a connection & Create a Table

const{ Database }=require('@jodu555/mysqlapi');constdatabase=Database.createDatabase('host','username','password','database');database.connect();database.createTable('tablename',{options: {PK: 'UUID',},columName: {type: 'columType',null: false,},});

Create a Table with Foreign Keys & Indexes

This Means that to the colum user_UUID will created an FK to the table users in the colum UUID

The K means that the columen name gets an index

database.createTable('services',{options: {PK: 'UUID',K: ['name'],FK: {user_UUID: 'users/UUID',},},UUID: {type: 'varchar(64)',null: false,},user_UUID: {type: 'varchar(64)',null: false,},name: 'varchar(64)',});

Create a Table with timestamps e.g (created_at, updated_at) and softdelete with deleted_at

database.createTable('services',{options: {//Enables softdeletesoftdelete: true,//Enable all available timestampstimestamps: true,//Enable only one or two with default naming only deletedAt if softdelete is activtimestamps: {cratedAt: true,updatedAt: false,deletedAt: true,},//Enable only one or two with custom colum naming only deletedAt if softdelete is activtimestamps: {cratedAt: 'created_at',updatedAt: 'updated_at',deletedAt: 'deleted_at',},PK: 'UUID',},UUID: {type: 'varchar(64)',null: false,},user_UUID: {type: 'varchar(64)',null: false,},name: 'varchar(64)',});

Work with the database in other classes | PUT this before you all over before you acces the database

const{ Database }=require('@jodu555/mysqlapi');constdatabase=Database.getDatabase();database.//some other function like get('tablename')

Create an Entry in a Table

//Retunrs the created Entrydatabase.get('tablename').create({columName: 'columValue',});

Get one or more Entry/s from a Table

//Returns one rowdatabase.get('tablename').getOne({searchColumName: 'searchColumValue',});//Returns an Array of rowsdatabase.get('tablename').get({searchColumName: 'searchColumValue',});

Update or Delete an Entry from a Table

//Returns the updated rowconstupdate=awaitdatabase.get('tablename').update({searchColumName: 'searchColumValue',},{updateColumName: 'updateColumValue',});awaitdatabase.get('tablename').delete({searchColumName: 'searchColumValue',});

Get Latest Entry by inseted / updated / deleted

//Returns the latest inseted / updated / deleted row//Gets the general latestawaitdatabase.get('tablename').getLatest('inserted');awaitdatabase.get('tablename').getLatest('updated');awaitdatabase.get('tablename').getLatest('deleted');//Gets the latest by a specific searchawaitdatabase.get('tablename').getLatest('type',{searchColumName: 'searchColumValue',});

Database implemented software caching usage

database.registerCache('nameOfTheCache',{time: 1000*60*60,//After 1 Hour the cache gets refreshedcalls: 3,//After 4 cause 3 is inc. calls from the cache it gets refreshed//These both values can work together or u only specify one of them},async(param)=>{//Here comes the code which gets called if the cache is initialized or refreshesreturn{};});// To get a cached valueconstoutput=awaitdatabase.getCache('nameOfTheCache').get('value');// This returns an object with infos about the calls the cachedTime and the data// => { data: {}, calls: 1, cached: false, cacheTime: 1638083909074 }//To Refresh the full cache with all kinds of passed parameters use:database.getCache('nameOfTheCache').refresh();//If you want to only refresh the cache for specific parameters use:database.getCache('nameOfTheCache').refresh('param1');

Database action callback usage

/** * IDENTIFIER Building: ACTION: CREATE / GET / GETONE / UPDATE / DELETE / LATEST Identifiers: tablename-ACTION : On a Specific Table a specific Action *-ACTION : On Any Table a specific Action *-* : On any Table any Action*/database.setCallback('IDENTIFIER',({ tablename, action, data })=>{//Here you can log the data or do whatever you want to do});

Projects using this API

• Monitoring-System
• AmazonPriceTracker
• YouTube-ChatBot
• Ez-Uploader
• CineFinn

Todos

• Document all the public functions with jsdoc so the usage gets easier
• Instead of JSDoc just rewrite in TypeScript would also make the DevEx much better
• Implement the pooling system so the connections dont fail
• Keep track of the actions obj in the thingdatabase
• Implement pseudo values which are based on actual values
• Implement multiple databases for redundancy
• Add possibility to createTable to auto implement the timestamps created_AT / updated_AT
• Add the possibility to activate softdelete and add in the timestamps
• Add the possibility to create indexes in tables
• Add the possibility to set callback functions for databse actions
• Add a function to get the latest one!!
• Engineer a newer way for the callbacks
  • 🤯 Hooks: 🤯
    • BeforeHook: You can manipulate the income object
    • MiddleHook: You can manipulate the sql code which gets build by the object
    • AfterHook: You can manipulate what happens after the sql code gets runned (eg. edit something in the return)
• Add the possibility to order a get statement
• ReEngineer the validation
• Validate if the Validation works just fine
• Add the Validation to the documentation
• Implement a whole caching system
  • Add This system to the documentation
• Schema Thing
  • XOR Option : So either the username or email or both
  • Immutable values
  • Virtual Variables
  • Accept a anonymous function for the default value

This Package is not finished yet. Please dont use in production environments as i do 🙄😏