FaStQL

Introduction

FaStQL is a wrapper for the SQL command-line interface (sqlcl), designed to make working with it faster and more convenient.

Its development is primarily aligned with the content and assignments of the Adatbázisok course at BME-VIK.

---

Development

You can track the ongoing development here. If you encounter a bug or have a feature request, feel free to open a ticket.

If you’d like to get involved, you can contribute to the FaStQL project.

You can also check out the Docker Hub repo.

Important

On Windows, node-pty requires the Spectre Mitigations version of some build tools and libraries. More information can be found here.

---

How to set up

FaStQL is currently distributed exclusively as a Docker image, thus you will need to install Docker on your system.

FaStQL supports all platforms that are compatible with Docker.

Tip

Using Docker Desktop can simplify things on all platforms, even on Linux, where many users prefer the CLI.

Create a folder, then create the following files:

docker-compose.yaml

services:
  fastql:
    container_name: FaStQL
    image: brni05/fastql:latest
    restart: unless-stopped
    env_file:
      - .env
    network_mode: "bridge"
    ports:
      - "${PORT}:${PORT}"
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "5"
    volumes:
      - ./output:/fastql/output

.env

# The path to the installed sqlcl executable
# The Docker image has sqlcl bundled at /fastql/external/sqlcl/bin/sql
SQLCL_PATH=/fastql/external/sqlcl/bin/sql

# The port on which the server (and the GUI) will be accessible
PORT=3333

Open a terminal in the folder you just created (this should be your current working directory).

To start FaStQL: docker compose up -d.

Tip

The FaStQL image is relatively large due to technical constraints, so downloading it may take a bit longer than usual.

Tip

You can view container logs using Docker Desktop.

To stop FaStQL: docker compose down.

---

How to use

In your browser, visit: http://localhost:3333/. The FaStQL GUI will appear.

Tip

You can use F11 to toggle fullscreen mode, but only when the terminal is not focused.

It will take a few seconds for sqlcl to start, but you should see the default startup output in a few seconds.

Important

Since FaStQL runs in a Docker container, a volume mount is needed to exchange data between the host and the container, which is done in the compose config.

As soon as you start the container, a folder named output will appear in the CWD.

The same folder exists in the container as well: /fastql/output.

To avoid data loss, FaStQL always prepends output/ to paths you input using the GUI.

Terminal:

• A psueod-terminal is rendered in the center of the screen with sqlcl already running.
• You can open multiple FaStQL instances in separate windows, each providing a fresh terminal.

Tip

Use Ctrl + C and Ctrl + Shift + V key combinations or the right-click menu to perform copy and paste actions. Ctrl + V is buggy (and does not paste) - avoid using it.

Ctrl + Shift + C also triggers a copy action, but opens the browser inspector as well.

Top toolbar:

• CONNECT

  • For the first time, enter your username and password.
    • FaStQL will remember your credentials for future use - just press Enter or the Connect button the next time to auto-fill the fields.
    • The connection string format is: username/password@//rapid.eik.bme.hu:1521/szglab.
  • If the session expires (eg. due to inactivity) just press Connect again.

• RUN

  • Enter the path to the script you want to run, relative to the host output folder.
  • If you leave the field empty, the placeholder path will be used by default (with output/ prepended).
  • You can omit the extension (.sql), FaStQL will append it.

• SPOOL

  • Spool: ✔ / ✖:

    • ✖: spooling is currently disabled.

    • Enter the path to the spool file you want to use, relative to the output folder. If the path (and/or file) does not exists, FaStQL will create it.

    • If you leave the field empty, the placeholder path will be used by default.

    • ✔: spooling is currently enabled - just press the button to disable it.

• COMPOSER

  • Use Composer to create and manage multi-line SQL commands. You can save them, load them, and execute them.

Tip

Certain SQL commands require a commit to take effect in the database. To undo changes (before committing), use rollback. There are dedicated buttons for both actions.

• SCRIPTER

  • A utility provided by db.bme.hu for creating SQL scripts required for submission on SQL1-2-3 labs.

Tip

You can resize FaStQL sub-windows by dragging their bottom-right corner.

• CLEAR

  • This button clears the console.

Bottom toolbar:

The bottom toolbar serves as a help menu, providing quick access to course materials and official sites for reference.

Tip

To update FaStQL: docker pull brni05/fastql:latest, then restart the container.

---

Technical details

• The FaStQL image includes sqlcl (version 24.3.1) bundled within it and does not rely on any sqlcl installations on the host. This is one reason for the big image size.

• FaStQL supports unlimited sessions, allowing you to open multiple windows that connect to the same database simultaneously.

• FastQL is fully cross-platform.

---

Legal

sqlcl is licensed under the Oracle Free Use Terms and Conditions. The full text of this license is published here.

The SQL script generation functionality (SCRIPTER) utilizes resources provided by db.bme.hu. The FaStQL project claims no ownership or credit.

FaStQL (excluding sqlcl) is licensed under the Apache 2.0 License.

This project bundles Monaco Editor by Microsoft Corporation, licensed under the MIT License. A copy of the Monaco Editor license is available here.