An implementation of PartiQL written in Rust

Document(WIP)

[tests.hello]
script = '''
cat<<EOS | pq -q "SELECT NAME, LOGNAME" -t json
{
  "SHELL": "/bin/bash",
  "NAME": "my machine name",
  "PWD": "/home/fuyutarow/piqel",
  "LOGNAME": "fuyutarow",
  "HOME": "/home/fuyutarow",
  "LANG": "C.UTF-8",
  "USER": "fuyutarow",
  "HOSTTYPE": "x86_64",
  "_": "/usr/bin/env"
}
EOS
'''
tobe = '''
[
  {
    "NAME": "my machine name",
    "LOGNAME": "fuyutarow"
  }
]
'''

Family

Table of Contants

• Features
• Motivation
• Usage
  • pretty print
  • convert file format
  • calculate BMI
• Installation
• Test
• LICNECE

Features

Motivation

What’s PartiQL?

Usage

pretty print

curl -s "https://api.github.com/repos/fuyutarow/piqel/commits?per_page=1" | pq

convert file format

use -t option c to convert Json, Yaml, Toml, and XML to each other.

cat pokemon.json | pq -t yaml

cat pokemon.json | pq -t yaml | pq -t toml

Comparison with existing command yj^[1]

*1 TOML of the following format cannot be serialized with yj, but it can be serialized with pq by replacing the fields accordingly.

{
  "name": "partiql-pokemon",
  "dependencies": {
    "react": "^16.13.1",
    "react-dom": "^16.13.1"
  },
  "license": "MIT"
}

Calculate BMI

1. Download the file and then calculate BMI in a local.

curl -s https://raw.githubusercontent.com/fuyutarow/pokemon.json/master/en/pokemon.json | pq -q "SELECT name, weight/height/height AS bmi ORDER BY bmi DESC LIMIT 20"

2. In a terminal, send a query to the server to calculate BMI in a remote.

curl https://partiql-pokemon.vercel.app/api/pokemon/ja -G --data-urlencode "q= SELECT name, weight/height/height AS bmi ORDER BY bmi DESC LIMIT 20"

3. In a web browser, send a query to the server to calculate BMI in a remote.

Installation

brew install fuyutarow/tap/pq
pq -h

scoop install pq
pq -h

Convert data

env | jo | pq "SELECT NAME AS name, USER AS user"

ip command is only available in Linux and WSL, not in Mac.

ip -j -p | pq "$(cat<<EOS
SELECT
  address,
  info.family AS inet,
  info.local
FROM addr_info AS info
WHERE inet LIKE 'inet%'
EOS
)"

• [x] SELECT
• [x] FROM
• [x] LEFT JOIN
• [x] WHERE
• [x] LIKE
• [x] ORDER BY
• [x] LIMIT

more examples

Test

Use tests-make to test CLI pq.

brew install fuyutarow/tap/tests-make
tests-make tests-make/index.toml

or

makers test:pq

code coverage

cargo install cargo-kcov
cargo kcov

or

makers cov

Preparation

makers install-dev

build

makers build
makers build:pq ;: for pq commnad

LICENCE

Appendix

Comparison of tools that can extract fields

jq^[2] approach

curl -s "https://api.github.com/repos/fuyutarow/piqel/commits?per_page=1" | jq  ".[].commit.author"

gron^[3] approach

curl -s "https://api.github.com/repos/fuyutarow/piqel/commits?per_page=1" | gron | grep "commit.author" | gron -u

nusehll^[4] approach

curl -s "https://api.github.com/repos/fuyutarow/piqel/commits?per_page=1" | from json | get commit.author | to json

pq^[5] approach

curl -s "https://api.github.com/repos/fuyutarow/piqel/commits?per_page=1" | pq -q "SELECT commit.author"

utils

• makers^[6]