SDKs & Tools

Harlequin

Browse Table schemas and query Spiral from a SQL terminal.

In development

Harlequin gives you an interactive SQL terminal for a Project's Tables, with Arrow query results and a schema browser. The Spiral adapter uses the ADBC driver, so queries run in DataFusion inside the terminal process and read storage through the SDK.

Install and connect

Install the SQL package's Harlequin extra, then select the spiral adapter and your Project:

pip install 'spiral-sql[harlequin]'
harlequin -a spiral 'spiraldb://?project=demo'

The extra includes Harlequin and the Python ADBC driver manager.

To use another branch, add &ref=feature-x to the URI. Use spiral:memory: in place of the Project URI to query local in-memory tables without signing in. The SQL package is available on PyPI.

Browse and query

Connect to open Harlequin's query editor and catalog sidebar. Expand the catalog, Project and a resolved Table to inspect its columns. The sidebar is limited to Tables that the driver has resolved; it does not enumerate every Table in the Project. You can query a Table by name even when it is absent from the sidebar.

Queries use DataFusion SQL and SPQL functions. Follow the ADBC query guide for Table names, parameters and supported writes, and the connection guide for credentials and snapshot selection.

Found a problem? Edit this page or report an issue.

On this page