Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giancarl021/csvql
A module to quickly query CSV data as a SQL
https://github.com/giancarl021/csvql
cli csv nodejs sql
Last synced: about 1 month ago
JSON representation
A module to quickly query CSV data as a SQL
- Host: GitHub
- URL: https://github.com/giancarl021/csvql
- Owner: Giancarl021
- License: mit
- Created: 2020-10-23T00:46:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T18:31:46.000Z (almost 4 years ago)
- Last Synced: 2024-05-28T19:39:51.660Z (8 months ago)
- Topics: cli, csv, nodejs, sql
- Language: JavaScript
- Homepage:
- Size: 104 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# csvql
A module to quickly query CSV data as a SQL
Similar packages:
* (Node) [tables](https://www.npmjs.com/package/tables)
* (Go) [textql](https://github.com/dinedal/textql)
## Installation
### CLI
npm:
```bash
npm install --global csvql
```
yarn:
```bash
yarn add global csvql
```
### API
npm:
```bash
npm install csvql
```
yarn:
```bash
yarn add csvql
```
## Usage
This module can be used in two formats: CLI and API.
### CLI
#### Create session
To start the application you use this command on terminal:
```bash
csvql [path/to/file1.csv[ path/to/file2.csv [...]]]
```
##### Arguments
Each argument needs to point to a CSV file.
##### Flags
* ``-p | --persist``: Create a disk database with the data when the session is closed. Values: `` | null``. If null a random name will be used;
* ``-d | --delimiter``: The delimiter of the CSV file. Default is ``,``. Values: ````;
* ``-D | --disk``: Create the session on a in-disk database, useful when the CSV is too large to a in-memory database;
* ``-f | --from``: Restart a persistent session in-memory. Values: ````; If invalid the startup will be aborted;
* ``--verbose``: Show top level JavaScript errors if they occur.
After that the interactive terminal of csvql will start.
#### Commands
The CLI have 4 commands:
##### Help
Prints all the available commands.
```
csvql> help
select : Queries into imported schemas.
schema : Manage the schemas of the current session.
list: List all tables and columns available.
import [, ...]]>: Import a new schema from CSV file(s).
drop : Delete a table of the current session.
rename : Rename a table of the current session.
help: List all available commands.
exit: Close the current session.
```
##### Exit
Close the application, equivalent of ``^C``.
##### Schema
Manages the schemes on the current session
**Operations**
*list*
List all the tables on current session, with the types.
*import*
Import CSV files, follows the syntax:
```
csvql> schema import path/to/file.csv [as table] [, ...]
```
*rename*
Rename a table on current session.
*drop*
Delete a table on current session.
##### Select
SQL SELECT Query, from [sqlite](https://www.sqlite.org/index.html).
### API
#### Initialization
```javascript
// Importing
const createCsvql = require('csvql');
// Initialize
const csvql = await createCsvql(files, options);
```
#### Files
You can provide initial file paths:
```javascript
const files = [
'path/to/file1',
'path/to/file2',
'path/to/file3',
...etc
];
```
#### Options
You can provide some options to change the behavior of the module:
```javascript
const options = {
from: null, // Import session (path/to/session)
persist: null, // Save session (path/to/session)
disk: null, // Create session on disk (path/to/session)
parseCommaAsDecimal: false // Parse strings like 0,123 as 0.123
};
```
#### Functions
##### schema
**list**
List all tables on current session
```javascript
const result = await csvql.schema('list');
```
Return:
```javascript
const result = [
{
name: 'file',
columns: [
'a': 'int',
'b': 'float'
]
},
...etc
]
```
**rename**
Rename a table on current session
```javascript
await csvql.schema('rename', 'oldName', 'newName');
```
**import**
```javascript
await csvql.schema('import', 'path/to/file');
```
**drop**
Delete a table on current session
```javascript
await csvql.schema('drop', 'file');
```
##### select
Run SQL-like ``SELECT``'s, as example:
```javascript
const result = await csvql.select('* from file1');
```
The result will be the same as the [better-sqlite3]() module, with the format:
```javascript
[
{
column: 'value'
}
]
```