Contents

Install

npm install database-js

Drivers

Usage

varConnection=require('database-js').Connection;// CONNECTIONvarconn=newConnection("sqlite:///path/to/test.sqlite");// SQLite// new Connection("mysql://user:password@localhost/test");     // MySQL// new Connection("postgres://user:password@localhost/test");  // PostgreSQL// 👉 Change the connection string according to the database driver// QUERYvarstmt1=conn.prepareStatement("SELECT * FROM city WHERE name = ?");stmt1.query("New York").then(function(results){console.log(results);// Display the results}).catch(function(reason){console.log(reason);// Some problem while performing the query});// COMMANDvarstmt2=conn.prepareStatement("INSERT INTO city (name, population) VALUES (?, ?)");stmt2.execute("Rio de Janeiro",6747815).then(function(){console.log('Inserted.');}).catch(function(reason){console.log('Error: '+reason);});// ANOTHER COMMANDvarstmt3=conn.prepareStatement("UPDATE city SET population = population + ? WHERE name = ?");stmt3.execute(1,"Rio de Janeiro").then(function(){console.log('Updated.');}).catch(function(reason){console.log('Error: '+reason);});// CLOSING THE CONNECTIONconn.close().then(function(){console.log('Closed.');}).catch(function(reason){console.log('Error: '+reason);});

Async / await

constConnection=require('database-js').Connection;(async()=>{letconn;try{// CONNECTIONconn=newConnection('mysql://user:password@localhost/test');// QUERYconststmt1=conn.prepareStatement('SELECT * FROM city WHERE name = ?');constresults=awaitstmt1.query('New York');console.log(results);// COMMAND 1conststmt2=conn.prepareStatement('INSERT INTO city (name, population) VALUES (?,?)');awaitstmt1.execute('Rio de Janeiro',6747815);// COMMAND 2conststmt2=conn.prepareStatement('UPDATE city SET population = population + ? WHERE name = ?');awaitstmt1.execute(1,'Rio de Janeiro');}catch(reason){console.log(reason);}finally{try{awaitconn.close();}catch(err){console.log(err);}}})();

Basic API

classConnection{/** Creates and prepares a statement with the given SQL. */prepareStatement(sql:string):PreparedStatement;/** Closes the underlying connection. */close():Promise<void>;/** Indicates whether the underlying driver support transactions. */isTransactionSupported():boolean;/** Returns true if the underlying driver is in a transaction, false otherwise. */inTransaction():boolean;/** * Starts a transaction (if supported). * * Transactions can fail to start if another transaction is already running or * if the driver does not support transactions. */beginTransaction():Promise<boolean>;/** * Commits a transaction (if supported). * * Transactions can fail to commit if no transaction was started, or if the driver * does not support transactions. */commit():Promise<boolean>;/** * Cancels a transaction (if supported). * * Transaction can fail to be rolled back no transaction was started, or if the driver * does not support transactions. */rollback():Promise<boolean>;}

classPreparedStatement{/** * Performs the prepared SQL query with the given arguments. * Returns a Promise with an array of rows. */query(...args:any):Promise<Array<any>>;/** Executes the prepared SQL statement with the given arguments. */execute(...args):Promise<any>;}

See also

License