Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngudbhav/excel-to-mysql
This NPM module puts all data from an Excel Spreadsheet to a table in MYSQL.
https://github.com/ngudbhav/excel-to-mysql
convert excel excel-to-mysql exceltomysql mysql npm npm-install npm-module npm-package
Last synced: 2 months ago
JSON representation
This NPM module puts all data from an Excel Spreadsheet to a table in MYSQL.
- Host: GitHub
- URL: https://github.com/ngudbhav/excel-to-mysql
- Owner: ngudbhav
- License: mit
- Created: 2018-09-29T14:35:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-01T17:49:38.000Z (about 2 years ago)
- Last Synced: 2024-10-31T19:38:33.707Z (3 months ago)
- Topics: convert, excel, excel-to-mysql, exceltomysql, mysql, npm, npm-install, npm-module, npm-package
- Language: JavaScript
- Homepage: https://npm.im/excel-to-mysql
- Size: 187 KB
- Stars: 6
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# excel-to-mysql
[](https://travis-ci.org/ngudbhav/excel-to-mysql) [](https://circleci.com/gh/ngudbhav/excel-to-mysql) 
This module converts your correctly formatted Excel spreadsheet to a specified table in specified database in MYSQL. The queries can also be written in a file (BETA).
## Excel Formats Supported
Supported Excel formats are XLS/XLSX/CSV.
## Usage
The Database must already be created in MYSQL. A table name should be provided. Please keep the column names in String format only.
## Spreadsheet Format
Please have a look at the sample Excel sheets provided to have a clear view of the File. Microsoft Sample Sheet (XLSX)
## Installation
```sh
npm install excel-to-mysql --save
```
## Testing
```sh
git clone https://github.com/ngudbhav/excel-to-mysql.git
cd excel-to-mysql/
```
Navigate to the folder.
```sh
cd test/
nano test.js
```
Now this file needs the MYSQL credentials. Provide those credentials in String format and save by pressing the following keys.
```sh
'CTRL+X'
'Y'
'Return'
```
Get back and test the module.
```sh
cd ..
npm test
```
## Using
Note: Please correctly format the Excel sheet else this won't work.
```sh
var excelMysql = require('excel-to-mysql');
```
This module needs 3 arguments.
The first one is the object with your credentials.
Database connection can be established in 2 ways.
1. Pass in your connection object which is the return of `mysql.createConnection`. The connection accepts connection both from mysql/mysql2. The same connection will be used to read/write data.
2. Pass in your credentials in the below format. `mysql` will be used to create a connection.
```sh
var credentialsForDB = {
host: host,
port: port || 3306,
user: MYSQL Username,
pass: Password for the above account,
path: path for the excel file,
table: Table name for creation,
db: Your Database name,
endConnection*: true,
connection:
};
```
* Please note that endConnection false may not terminate the process.
```sh
var credentialsForFile = {
path: path for the excel file,
table: Table name for creation,
db: Your Database name
};
```
The second one is an optional argument of options with default values as follows.
```sh
var options = {
verbose: true // logs the steps undergoing.
autoId: false // Automatically insert id of every row, i.e., numbering every row.
customStartEnd: false // Custom insert the row and columns rather than full excel-file.
startRow: // Valid only if customStartEnd is true. Defines the start Row of the data.
endRow: // Valid only if customStartEnd is true. Defines the end Row of the data.
startCol: // Valid only if customStartEnd is true. Defines the start Column of the data.
endCol: // Valid only if customStartEnd is true. Defines the end Column of the data.
safeMode: false // Backup the db to the with .sql as file name.
destination: // Valid only if safeMode is true. The location of db.sql file.
}
```
The third argument is the callback function which will be executed only after the completion of the whole conversion.
```sh
try {
excelMysql.covertToMYSQL(credentials, options, callback);
excelMysql.convertToFile(credentials, options, callback);
} catch(error) {
throw error;
}
```
`try/catch` is always recommended because of the type of errors that can occur.
convertToFile Function will write the .sql file to the current working directory if no destination is provided with db.sql as the file name.
## Want to covert to MongoDB instead
We have got you covered! Github Link.
## Want to use the GUI instead
We have got you covered! Github Link.