|
| 1 | +--- |
| 2 | +title: 'DBeaver' |
| 3 | +sidebar_label: 'DBeaver' |
| 4 | +description: 'Configure DBeaver to query Spice via JDBC' |
| 5 | +sidebar_position: 2 |
| 6 | +pagination_prev: 'clients/index' |
| 7 | +pagination_next: null |
| 8 | +--- |
| 9 | + |
| 10 | +1. Start the Spice runtime with a dataset loaded. Follow the [quickstart guide](/docs/getting-started) to get started. |
| 11 | + |
| 12 | +2. Download [DBeaver Community Edition](https://dbeaver.io). |
| 13 | + |
| 14 | +3. Download the [Apache Arrow Flight SQL JDBC driver](https://search.maven.org/search?q=a:flight-sql-jdbc-driver) - choose the "jar" option. |
| 15 | + |
| 16 | +4. Launch DBeaver |
| 17 | + |
| 18 | +5. In the DBeaver application menu bar, open the "Database" menu and choose: "Driver Manager": |
| 19 | +  |
| 20 | + |
| 21 | +6. Click the "New" button on the right: |
| 22 | +  |
| 23 | + |
| 24 | +7. Add the JDBC jar file: |
| 25 | + 1. Click the "Libraries" tab |
| 26 | + 1. Click the: "Add File" button |
| 27 | + 1. Choose the "flight-sql-jdbc-driver-15.0.1.jar" jar file (the file downloaded in step 3 above) - and click "Open" |
| 28 | +  |
| 29 | + 1. Close the Driver editor window with the blue "OK" button on the lower-right |
| 30 | + |
| 31 | +8. Enter the driver settings: |
| 32 | + 1. Click the "Settings" tab |
| 33 | + 1. In the "Driver Name" field - enter: `Apache Arrow Flight SQL` |
| 34 | + 1. In the "URL Template" field - enter: `jdbc:arrow-flight-sql://{host}:{port}?useEncryption=false&disableCertificateVerification=true` |
| 35 | + - If [API key authentication](../../api/auth/index.md) is enabled, the URL template should be: `jdbc:arrow-flight-sql://{host}:{port}?useEncryption=false&disableCertificateVerification=true&user=&password=<enter-api-key-here>` - where `<enter-api-key-here>` is the API key value |
| 36 | + 1. In the "Driver Type" drop-down box - choose: "SQLite" |
| 37 | + 1. Select "No authentication" |
| 38 | + - This should be selected even if API key authentication is enabled in the runtime, as the API key is supplied via the URL template above. |
| 39 | + 1. The driver manager "Edit Driver" window should look like this: |
| 40 | +  |
| 41 | + 1. Click the blue "OK" button on the lower-right to save the driver |
| 42 | + 1. Close the "Driver Manager" window by clicking the blue "Close" button on the lower-right. |
| 43 | + |
| 44 | +9. Create a new Database Connection: |
| 45 | + 1. In the DBeaver application menu bar, open the "Database" menu and choose: "New Database Connection": |
| 46 | +  |
| 47 | + 1. In the "Connect to a database" window - type: `Flight` in the search bar |
| 48 | + 1. Choose the `Apache Arrow Flight SQL` driver - the window should look like this: |
| 49 | +  |
| 50 | + 1. Click the blue "Next >" button on the bottom of the window |
| 51 | + 1. 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: |
| 52 | +  |
| 53 | + 1. Click the "Test Connection" button - the window should look like this: |
| 54 | +  |
| 55 | + 1. Click the blue "OK" button to close the Connection test window |
| 56 | + 1. Click the "Connection details (name, type, ...)" button on the right |
| 57 | + 1. In the "General" section, enter: `Spice Runtime` for the "Connection name". It should look like this: |
| 58 | +  |
| 59 | + 1. Click the blue "Finish" button to save the connection |
| 60 | + |
| 61 | +10. Run a query: |
| 62 | + 1. Right-click on the Database Connection on the left - choose: "SQL Editor", and then: "Open SQL Console" as shown here: |
| 63 | +  |
| 64 | + 1. In the Console window - run a query - something like: `SELECT * FROM taxi_trips;` |
| 65 | + 1. Click the triangle button to execute the SQL statement - as shown below (or use keyboard shortcut: Ctrl+Enter): |
| 66 | +  |
| 67 | + 1. See the query results as shown in this screenshot: |
| 68 | +  |
| 69 | + 1. DBeaver is now configured to query the Spice runtime using SQL! 🎉 |
0 commit comments