Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noborus/xlsxsql
A CLI tool that executes SQL queries on various files including xlsx files and outputs the results to various files
https://github.com/noborus/xlsxsql
excel sql trdsql xlsx
Last synced: 12 days ago
JSON representation
A CLI tool that executes SQL queries on various files including xlsx files and outputs the results to various files
- Host: GitHub
- URL: https://github.com/noborus/xlsxsql
- Owner: noborus
- License: mit
- Created: 2023-10-26T07:05:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-10T23:40:55.000Z (10 months ago)
- Last Synced: 2024-01-11T01:04:50.794Z (10 months ago)
- Topics: excel, sql, trdsql, xlsx
- Language: Go
- Homepage:
- Size: 129 KB
- Stars: 74
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xlsxsql
[](https://pkg.go.dev/github.com/noborus/xlsxsql)
[](https://github.com/noborus/xlsxsql/actions)
A CLI tool that executes SQL queries on various files including xlsx files and outputs the results to various files.
| id | name | price |
|----|--------|-------|
| 1 | apple | 100 |
| 2 | orange | 50 |
| 3 | melon | 500 |
A CLI tool that executes SQL queries on xlsx files and outputs the results to various files, and also executes SQL queries on various files and outputs them to xlsx files.
Built using [excelize](https://github.com/qax-os/excelize) and [trdsql](https://github.com/noborus/trdsql).
## Install
### Go install
```console
go install github.com/noborus/xlsxsql/cmd/xlsxsql@latest
```
### Homebrew
You can install Homebrew's xlsxsql with the following command:
```console
brew install noborus/tap/xlsxsql
```
### Binary Downloads
Precompiled binaries for xlsxsql are available for various platforms and architectures. You can download them from the [GitHub Releases](https://github.com/noborus/xlsxsql/releases) page.
The following binaries can be downloaded from release.
- Darwin_arm64
- Darwin_x86_64
- Linux_arm64
- Linux_i386
- Linux_x86_64
- Windows_arm64
- Windows_x86_64
To install a binary, download the appropriate file for your system, extract it, and place the `xlsxsql` executable in a directory included in your system's `PATH`.
For example, on a Unix-like system, you might do:
```console
tar xvf xlsxsql_Darwin_x86_64.tar.gz
mv xlsxsql /usr/local/bin/
```
## Usage
```console
$ xlsxsql --help
Execute SQL against xlsx file.
Output to CSV and various formats.
Usage:
xlsxsql [flags]
xlsxsql [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
list List the sheets of the xlsx file
query Executes the specified SQL query against the xlsx file
table SQL(SELECT * FROM table) for xlsx
Flags:
--clear-sheet Clear sheet when outputting to xlsx file
--debug debug mode
-H, --header Input header
-h, --help help for xlsxsql
-o, --out string Output Format[CSV|AT|LTSV|JSON|JSONL|TBLN|RAW|MD|VF|YAML|XLSX] (default "GUESS")
--out-cell string Cell name to output to xlsx file
-O, --out-file string File name to output to file
--out-header Output header
--out-sheet string Sheet name to output to xlsx file
-s, --skip int Skip the number of lines
-v, --version display version information
Use "xlsxsql [command] --help" for more information about a command.
```
### List sheets
```console
$ xlsxsql list test.xlsx
Sheet1
Sheet2
```
### Basic usage
The basic usage of xlsxsql is to run a SQL query against an Excel file.
The `query` command is used followed by the SQL query in quotes.
The SQL query should include the name of the Excel file. If no sheet is specified, the first sheet will be targeted.
```console
xlsxsql query "SELECT * FROM test.xlsx"
```
For example, if test.xlsx contains the following data in its first sheet:
| Name | Age |
| ----- | --- |
| Alice | 20 |
| Bob | 25 |
| Carol | 30 |
The output will be:
```csv
Name,Age
Alice,20
Bob,25
Carol,30
```
`xlsxsql` is an extended version of [trdsql](https://github.com/noborus/trdsql),
so you can execute SQL on files such as CSV and JSON.
```console
xlsxsql query "SELECT * FROM test.csv"
```
In other words, you can also do CSV and JOIN.
```console
xlsxsql query -H -o md \
"SELECT a.id,a.name,b.price
FROM testdata/test3.xlsx::.C1 AS a
LEFT JOIN test.csv AS b
ON a.id=b.id"
```
### Specify sheet
The sheet can be specified by using a double colon "::" after the file name
(the first sheet is selected by default if not specified).
```console
xlsxsql query "SELECT * FROM test.xlsx::Sheet2"
```
### Specify cell
Cell can be specified by using a dot "." after the sheet.
```console
xlsxsql query "SELECT * FROM test3.xlsx::Sheet1.C1"
```
Optional if the sheet is the first sheet.
```console
xlsxsql query "SELECT * FROM test3.xlsx::.C1"
```
> [!NOTE]
> If cell is specified, the table up to the blank column is considered to be the table.
This allows multiple tables to be specified on one sheet, and JOIN is also possible.
```console
xlsxsql query -H -o md \
"SELECT a.id,a.name,b.price
FROM testdata/test3.xlsx::.C1 AS a
LEFT JOIN testdata/test3.xlsx::.F4 AS b
ON a.id=b.id"
```
### Shorthand designation
The `table` command is a shorthand that allows you to quickly display the contents of a specified sheet in a table format.
The syntax is `xlsxsql table ::.`.
If no sheet name is specified, the first sheet of the Excel file will be targeted.
Here is an example:
```console
xlsxsql table test.xlsx::Sheet2.C1
```
It can be omitted for the first sheet.
```console
xlsxsql table test.xlsx::.C1
```
### Skip Options
The `--skip` or `-s` option skips the specified number of lines.
For example, you would use it like this:
```console
xlsxsql query --skip 1 "SELECT * FROM test.xlsx::Sheet2"
```
Skip is useful when specifying sheets, allowing you to skip unnecessary rows.
(There seems to be no advantage to using skip when specifying Cell.)
### Output format
```console
xlsxsql query --out JSONL "SELECT * FROM test.xlsx::Sheet2"
```
You can choose from CSV, LTSV, JSON, JSONL, TBLN, RAW, MD, VF, YAML, (XLSX).
### Output to xlsx file
You can output the result to an xlsx file by specifying a file name with the `.xlsx` extension as the `--out-file` option. For example:
```console
xlsxsql query --out-file test2.xlsx "SELECT * FROM test.xlsx::Sheet2"
```
> [!NOTE]
> You can also output to the same xlsx file as the input file. Please be careful as the contents will be overwritten.
> [!NOTE]
> Even if you specify XLSX with --out, you must specify a file name with the extension `.xlsx`.
This command will execute the SQL query on the Sheet1 of test.xlsx and output the result to result.xlsx.
If the file does not exist, it will be created. If the file already exists, the results will be updated.
You can specify the `sheet` and `cell` to output, if you want to output to an xlsx file. For example:
```console
xlsxsql query --out-file test2.xlsx --out-sheet Sheet2 --out-cell C1 "SELECT * FROM test.xlsx::Sheet2"
```
You can clear the sheet before outputting to an xlsx file by specifying the `--clear-sheet` option. For example:
```console
xlsxsql query --out-file test2.xlsx --clear-sheet "SELECT * FROM test.xlsx::Sheet2"
```
### Multiple queries
It is also possible to output after executing an update query.
A SELECT query is required for output.
```console
xlsxsql query --header --out-header --out-file test.xlsx --out-sheet Sheet2 \
"UPDATE test.xlsx SET Age=Age+1 WHERE Name='Alice';
SELECT * FROM test.xlsx"
```