Coder Social home page Coder Social logo

mysql-import's Introduction

Version 5.0.21 (NPM) (Github)

Build Status Coverage Status

Import MySQL files with Node!

Table of Contents

Install

via NPM:

$ npm install --save-dev mysql-import

Via Github:

git clone https://github.com/Pamblam/mysql-import.git

TLDR:

const host = 'localhost';
const user = 'root';
const password = 'password';
const database = 'mydb';

const Importer = require('mysql-import');
const importer = new Importer({host, user, password, database});

// New onProgress method, added in version 5.0!
importer.onProgress(progress=>{
  var percent = Math.floor(progress.bytes_processed / progress.total_bytes * 10000) / 100;
  console.log(`${percent}% Completed`);
});

importer.import('path/to/dump.sql').then(()=>{
  var files_imported = importer.getImported();
  console.log(`${files_imported.length} SQL file(s) imported.`);
}).catch(err=>{
  console.error(err);
});

Methods

new Importer({host, user, password[, database]})

The constructor requires an object with a host, user, and password parameter. Passing in a database parameter is optional.

Importer.prototype.getImported()

Get an array of files imported.

Importer.prototype.setEncoding(encoding)

Set the encoding to use when reading import files. Supported arguments are: utf8, ucs2, utf16le, latin1, ascii, base64, or hex.

Importer.prototype.use(database)

Set or change the database to import to.

Importer.prototype.onProgress(callback)

(New in v. 5.0!) - Set a callback to be called as the importer processes chunks of the dump file. Callback is provided an object with the following properties:

  • total_files: The total files in the queue.
  • file_no: The number of the current dump file in the queue.
  • bytes_processed: The number of bytes of the file processed.
  • total_bytes: The size of the dump file.
  • file_path: The full path to the dump file.

Importer.prototype.onDumpCompleted(callback)

(New in v. 5.0!) - Set a callback to be called after each dump file has completed processing. Callback is provided an object with the following properties:

  • total_files: The total files in the queue.
  • file_no: The number of the current dump file in the queue.
  • file_path: The full path to the dump file.
  • error: If there was an error, the error object; if no errors, this will be null.

Importer.prototype.import(...input)

Import an .sql file or files into the database. This method will take...

  • Any number of paths to individual .sql files.
    importer.import('path/to/dump1.sql', 'path/to/dum2.sql')
    
  • Any number of paths that contain any number of .sql files.
    importer.import('path/to/mysqldumps/')
    
  • Any number of arrays containing either of the above.
    importer.import(['path/to/dump.sql', 'path/to/dumps/'])
    
  • Any combination of any of the above.

Importer.prototype.disconnect(graceful=true)

Disconnects the connection. If graceful is switched to false it will force close any connections. This is called automatically after files are imported so typically this method should never be required.

Contributing

Contributions are more than welcome! Please check out the Contributing Guidelines for this project.

mysql-import's People

Contributors

pamblam avatar sobolevn avatar oscarteg avatar sasadjolic avatar lightbringer1991 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.