DBeaver
-
Start the Spice runtime with a dataset loaded. Follow the quickstart guide to get started.
-
Download DBeaver Community Edition.
-
Download the Apache Arrow Flight SQL JDBC driver - choose the "jar" option.
-
Launch DBeaver
-
In the DBeaver application menu bar, open the "Database" menu and choose: "Driver Manager":
-
Click the "New" button on the right:
-
Add the JDBC jar file:
- Click the "Libraries" tab
- Click the: "Add File" button
- Choose the "flight-sql-jdbc-driver-15.0.1.jar" jar file (the file downloaded in step 3 above) - and click "Open"
- Close the Driver editor window with the blue "OK" button on the lower-right
-
Enter the driver settings:
- Click the "Settings" tab
- In the "Driver Name" field - enter:
Apache Arrow Flight SQL
- In the "URL Template" field - enter:
jdbc:arrow-flight-sql://{host}:{port}?useEncryption=false&disableCertificateVerification=true
- In the "Driver Type" drop-down box - choose: "SQLite"
- Select "No authentication"
- The driver manager "Edit Driver" window should look like this:
- Click the blue "OK" button on the lower-right to save the driver
- Close the "Driver Manager" window by clicking the blue "Close" button on the lower-right.
-
Create a new Database Connection:
- In the DBeaver application menu bar, open the "Database" menu and choose: "New Database Connection":
- In the "Connect to a database" window - type:
Flight
in the search bar - Choose the
Apache Arrow Flight SQL
driver - the window should look like this: - Click the blue "Next >" button on the bottom of the window
- On the next screen, the JDBC URL should be filled out already - just supply the Host (
localhost
) and Port (50051
) values for the Spice runtime. The window should look like this: - Click the "Test Connection" button - the window should look like this:
- Click the blue "OK" button to close the Connection test window
- Click the "Connection details (name, type, ...)" button on the right
- In the "General" section, enter:
Spice Runtime
for the "Connection name". It should look like this: - Click the blue "Finish" button to save the connection
-
Run a query:
- Right-click on the Database Connection on the left - choose: "SQL Editor", and then: "Open SQL Console" as shown here:
- In the Console window - run a query - something like:
SELECT * FROM taxi_trips;
- Click the triangle button to execute the SQL statement - as shown below (or use keyboard shortcut: Ctrl+Enter):
- See the query results as shown in this screenshot:
- DBeaver is now configured to query the Spice runtime using SQL! 🎉