npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

csvql

v0.1.6

Published

A module to quickly query CSV data as a SQL

Downloads

19

Readme

csvql

A module to quickly query CSV data as a SQL

Similar packages:

Installation

CLI

npm:

npm install --global csvql

yarn:

yarn add global csvql

API

npm:

npm install csvql

yarn:

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:

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: <session-name> | null. If null a random name will be used;
  • -d | --delimiter: The delimiter of the CSV file. Default is ,. Values: <delimiter>;
  • -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: <session-name>; 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 <sql query>: Queries into imported schemas.
schema <operation>: Manage the schemas of the current session.
  list: List all tables and columns available.
  import <path [as <tableName>[, ...]]>: Import a new schema from CSV file(s).
  drop <tableName>: Delete a table of the current session.
  rename <tableName> <newTableName>: 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.

API

Initialization

// Importing
const createCsvql = require('csvql');

// Initialize
const csvql = await createCsvql(files, options);

Files

You can provide initial file paths:

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:

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

const result = await csvql.schema('list');

Return:

const result = [
	{
		name: 'file',
		columns: [
			'a': 'int',
			'b': 'float'
		]
	},
	...etc
]

rename

Rename a table on current session

await csvql.schema('rename', 'oldName', 'newName');

import

await csvql.schema('import', 'path/to/file');

drop

Delete a table on current session

await csvql.schema('drop', 'file');
select

Run SQL-like SELECT's, as example:

const result = await csvql.select('* from file1');

The result will be the same as the better-sqlite3 module, with the format:

[
	{
		column: 'value'
	}
]