GizmoSQLLine

A GizmoSQL JDBC-based version of SQLLine for connecting to GizmoSQL instances.

GizmoSQLLine bundles SQLLine with the GizmoSQL JDBC driver, providing an easy-to-use command-line SQL client for GizmoSQL servers. The GizmoSQL JDBC driver supports both client-side and server-side query cancellation.

Features

• Pre-configured with GizmoSQL JDBC driver (v1.5.0)
• OAuth/SSO support via server-side authorization code exchange
• Client-side and server-side query cancellation support
• Single executable with all dependencies included
• Full SQLLine functionality (command history, tab completion, output formatting)
• Support for TLS encryption and various authentication methods

Installation

Homebrew (Recommended)

The easiest way to install GizmoSQLLine on macOS or Linux:

brew install gizmodata/tap/gizmosqlline

This automatically installs Java (OpenJDK) if needed.

Download Release

Download from the Releases page:

Platform	File	Instructions
Linux/macOS	gizmosqlline	chmod +x gizmosqlline && ./gizmosqlline
Windows	gizmosqlline.jar + gizmosqlline.bat	Download both to same folder, run gizmosqlline.bat
Any	gizmosqlline.jar	java --add-opens=java.base/java.nio=ALL-UNNAMED --enable-native-access=ALL-UNNAMED -jar gizmosqlline.jar

Quick Install (Linux/macOS)

curl -L -o gizmosqlline https://github.com/gizmodata/gizmosqlline/releases/latest/download/gizmosqlline
chmod +x gizmosqlline
sudo mv gizmosqlline /usr/local/bin/

Requires: Java 11+ runtime installed

Build from Source

git clone https://github.com/gizmodata/gizmosqlline.git
cd gizmosqlline
mvn clean package

The executable will be available at target/gizmosqlline.

Usage

Interactive Mode

./gizmosqlline

Then connect to a GizmoSQL server:

sqlline> !connect jdbc:gizmosql://localhost:31337 user password

Command Line Connection

./gizmosqlline -u "jdbc:gizmosql://localhost:31337" -n user -p password

Connection URL Format

jdbc:gizmosql://host:port[?param1=value1&param2=value2]

Common Connection Parameters

Parameter	Description
useEncryption	Enable TLS encryption (true/false)
disableCertificateVerification	Skip certificate verification (true/false)
token	Bearer token for authentication
authType	Set to external to enable server-side OAuth/SSO
oauthServerPort	Custom OAuth server port (default: 31339)
user	Username for authentication
password	Password for authentication

Example Connections

# Basic connection (no encryption)
./gizmosqlline -u "jdbc:gizmosql://localhost:31337" -n admin -p secret

# With TLS encryption
./gizmosqlline -u "jdbc:gizmosql://localhost:31337?useEncryption=true" -n admin -p secret

# With bearer token
./gizmosqlline -u "jdbc:gizmosql://localhost:31337?token=your-bearer-token"

# Skip certificate verification (development only)
./gizmosqlline -u "jdbc:gizmosql://localhost:31337?useEncryption=true&disableCertificateVerification=true" -n admin -p secret

# OAuth/SSO (opens browser for login)
./gizmosqlline -u "jdbc:gizmosql://localhost:31337?authType=external" -n "" -p ""

# OAuth/SSO with custom OAuth server port
./gizmosqlline -u "jdbc:gizmosql://localhost:31337?authType=external&oauthServerPort=8443" -n "" -p ""

OAuth/SSO

GizmoSQLLine supports server-side OAuth/SSO authentication via the GizmoSQL JDBC driver. When authType=external is specified, the driver will:

1. Contact the GizmoSQL OAuth server to initiate an authorization flow
2. Open your default browser for IdP login (e.g., Google, Okta)
3. Exchange the authorization code for an identity token (server-side)
4. Authenticate to GizmoSQL using the identity token

In interactive mode:

sqlline> !connect jdbc:gizmosql://host:port?authType=external "" ""

The empty username and password ("") are required by SQLLine's !connect syntax but are ignored when authType=external is set.

SQLLine Commands

Once connected, you can use standard SQLLine commands:

Command	Description
!help	Show all available commands
!tables	List all tables
!columns <table>	Show columns for a table
!describe <table>	Describe a table
!outputformat <format>	Set output format (table, csv, json, etc.)
!quit	Exit GizmoSQLLine

Building

Requirements

• Java 11 or higher
• Maven 3.6 or higher

Build Commands

# Build the executable
mvn clean package

# Skip tests
mvn clean package -DskipTests

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

This project bundles:

• SQLLine - BSD-3-Clause License
• GizmoSQL JDBC Driver - Apache License 2.0

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.