# sqljs-table-loader

> CSV/xlsx table loader for sql.js

Latest version **1.0.2** (published 2020-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install sqljs-table-loader
pnpm add sqljs-table-loader
yarn add sqljs-table-loader
bun add sqljs-table-loader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-07-10 |
| First published | 2019-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | MacRat |
| Maintainers | macrat |

## Links

- npm: https://www.npmjs.com/package/sqljs-table-loader
- Repository: https://github.com/macrat/sqljs-table-loader
- Homepage: https://github.com/macrat/sqljs-table-loader#readme
- Issues: https://github.com/macrat/sqljs-table-loader/issues
- npm.io page: https://npm.io/package/sqljs-table-loader

## Dependencies (2)

- [xlsx](https://npm.io/package/xlsx.md) ^0.16.3
- [sql.js](https://npm.io/package/sql.js.md) ^1.3.0

## Recent versions

- 1.0.2 (latest) — 2020-07-10
- 1.0.1 — 2019-05-19
- 0.0.0 — 2019-05-12

## README

SQL.js TableLoader
==================

[![Build Status](https://travis-ci.org/macrat/sqljs-table-loader.svg?branch=master)](https://travis-ci.org/macrat/sqljs-table-loader)
[![Test Coverage](https://api.codeclimate.com/v1/badges/acf76e20e48a6f573e18/test_coverage)](https://codeclimate.com/github/macrat/sqljs-table-loader/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/acf76e20e48a6f573e18/maintainability)](https://codeclimate.com/github/macrat/sqljs-table-loader/maintainability)

excel/csv file loader for [SQL.js](https://github.com/kripken/sql.js).

## Usage
### in Node.js
``` shell
$ npm install sqljs-table-loader
```

``` javascript
import fs from 'fs';
import initSqlJs from 'sql.js';
import TableLoader from 'sqljs-table-loader';


const data = fs.readFileSync(__dirname + '/file.xlsx');
const loader = new TableLoader(data, {/* options (see below) */});

initSqlJs(sql => {
	const db = new sql.Database();

	console.log(loader.sheets);  // view sheet names included in excel file
	console.log(loader.read({/* override options (see below) */}));  // view table data

	loader.importInto(db, 'target_table', {/* override options (see below) */});  // create table and import data

	console.log(db.exec('SELECT * FROM target_table'));
});
```

### in browser
``` html
<script src="https://unpkg.com/xlsx"></script>  <!-- required -->
<script src="https://unpkg.com/sql.js"></script>  <!-- optional -->
<script src="https://unpkg.com/sqljs-table-loader"></script>  <!-- this library -->
<script>
var loader = new TableLoader('foo,bar\n1,hello\n2,world');

console.log(loader.sheets);
console.log(loader.read());
</script>
```

## Options
|name       |default|description                                 |
|-----------|-------|--------------------------------------------|
|skip\_row  |0      |Skip first rows                             |
|use\_header|true   |Use first row as column names               |
|sheet      |null   |Sheet name to load (if null, load first)    |
|delimiter  |','    |The delimiter for csv (only for constructor)|

---
_Source: https://npm.io/package/sqljs-table-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._