Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reiniiriarios/squirrel-table

Desktop application to run MySQL queries over SSH and generate CSV and XLSX files. Useful for QA where queries need to be run repeatedly and files handed off.
https://github.com/reiniiriarios/squirrel-table

csv csv-files data-analysis desktop-application electron excel mariadb mysql nodejs qa quality-assurance quality-control quality-control-assurance sql xlsx

Last synced: 9 days ago
JSON representation

Desktop application to run MySQL queries over SSH and generate CSV and XLSX files. Useful for QA where queries need to be run repeatedly and files handed off.

Awesome Lists containing this project

README 

        
# SquirrelTable



SquirrelTable is a desktop application that can run MySQL queries over SSH and generate CSV and XLSX files. Useful for QA where queries need to be run repeatedly and files handed off. Typical usage within a team might be to have a directory of SQL files syncing over cloud storage that one person can update and other people can simply open SquirrelTable and run as they need.



![](https://raw.githubusercontent.com/reiniiriarios/squirrel-table/master/screenshots/query.png)



## Latest Release



* [Windows x64 Installer](https://github.com/reiniiriarios/squirrel-table/releases/download/v0.6.3/SquirrelTableSetup.exe)

* [Windows x64 Portable](https://github.com/reiniiriarios/squirrel-table/releases/download/v0.6.3/SquirrelTable-win32-x64-0.6.3.zip)



## Getting Started



After installing, select a directory of SQL files and configure your database connection and SSH settings if connecting through a tunnel.



Any commented lines in SQL files will appear at the bottom of the screen under Comments rather than in-line.



After running a query, results will be displayed. You can then save the results as a CSV or XLSX.



![](https://raw.githubusercontent.com/reiniiriarios/squirrel-table/master/screenshots/results.png)



### Importing and Exporting Settings



If you want to copy your settings to another device or want to quickly set up other users, you can export your settings as a `.json` file. Your login information and SSH key will be encrypted. Upon importing, the SSH key is decrypted and stored alongside the imported preferences file. If you change the key file after importing, the imported key will be deleted.



## Why SquirrelTable?



Finding myself writing query after query for data analysis and QA, I was using HeidiSQL, but wanted a simpler solution for myself and needed a simpler solution to distribute to other employees. My primary use for the app is in an ecommerce environment, but the app could be useful wherever there's a regular and evolving need for data analysis and/or QA.



### Specific Use Cases



* Generating statistics on how often different shipping methods are used.

* Finding user errors that aren't caught, such as setting incorrect product visibility settings. Not specifically an error, but incorrect nonetheless.

* Finding users who have tried to add a third party connection, such as a shipping integration, but never finished setting it up (maybe they used the wrong account ID).

* Pulling a list of users who have been inactive but have added products. Or who haven't.

* Finding out how long, on average, it takes between users signing up for an account and adding their first product, then their third, split by user demographics.



## Why "SquirrelTable?"

SQL...SQuirreL :3



## To Do



* Auto-refresh when files in directory change

* Ctrl+F Find in results



## Running & Making from Source



SquirrelTable is built on [Node.js](https://nodejs.org/) with [Electron](https://www.electronjs.org/) using [Electron Forge](https://www.electronforge.io/).



After installing Node.js, if not already installed:



`git clone https://github.com/reiniiriarios/squirrel-table.git`



`cd squirrel-table`



`npm install`



`npm run scss`



See `forge.config.js` for settings. You'll need to edit as needed.



### To Run



`npm start`



### To Make



`npm run make`