mysql-import

mysql-import

Version 1.0.5

Import MySQL files with Node!

Install

$ npm install --save mysql-import

Usage

Include the package.

const mysql_import = require('mysql-import');

mysql-import exposes two methods and version property. mysql_import.version is a string showing the current version of the package.

config(Object settings)

Prepare the package to communicate with your database and handle any errors. This method must be called before importing anything.

The settings object has 4 mandatory parameters and 1 optional parameter.

• host - (mandatory) The MySQL host to connect to.
• user - (mandatory) The MySQL user to connect with.
• password - (mandatory) The password for the user.
• database - (mandatory) The database to connect to.
• onerror - (optional) Function to handle errors. The function will receive the Error. If not provided the error will be thrown.

The config method returns the mysql-import object so it may be chained.

import(String filename)

Import a .sql file to the database.

The import method returns a Promise.

Note that each query in the text file must terminate with an unquoted semicolon (;) followed by a newline or the end of the file.

Example

require('mysql-import').config({
	host: 'localhost',
	user: 'testuser',
	password: 'testpwd',
	database: 'mydb',
	onerror: err=>console.log(err.message)
}).import('mydb.sql').then(()=> {
	console.log('all statements have been executed')
});

Credit where credit is due

This is a fork of the node package node-mysql-importer originally created by some European dude. I was using this as a dependency in another project and had a few issues (namely, semicolons in the import data causing errors). I left an issue on his repo and he promptly deleted (or hid) the repo, so I fixed it myself and will maintain my own copy. This one has a much more robust pre-parser, and is almost entirely re-written.

Thanks for your work, Mark.