# SQuirreL SQL

You can use SQuirreL SQL to interface with HeavyDB.

SQuirreL SQL client is a graphical Java program for performing common tasks such as viewing the structure of a JDBC-compliant database, browsing data in tables, and issuing SQL commands.

For more information about SQuirreL SQL, see [http://squirrel-sql.sourceforge.net](http://squirrel-sql.sourceforge.net/).

## Installing SQuirreL SQL

1. Download the HEAVY.AIU JDBC driver in `$HEAVYAI_PATH/bin/heavyaijdbc-<major_version>.<minor_version>.<revision>.jar`.
2. Verify that Java is installed on your client:

   1. On Windows, go to Control Panel > Programs > Programs and Features.

   -or-

   1. On OSX, go to System Preferences > Java and click **About...**.
3. Download the version of SQuirreL SQL for your platform from [http://squirrel-sql.sourceforge.net](http://squirrel-sql.sourceforge.net/).
4. Follow the instructions on the [SQuirreL SQL website](http://www.squirrelsql.org/) to install SQuirreL SQL.

## Configuring SQuirreL SQL for the HEAVY.AI JDBC Driver

### Configure the HEAVY.AI Driver

1. Open SQuirreL SQL.
2. Click **Drivers**.
3. Click **+** to add a new driver.
4. Enter the **Name** for your driver. The name is an alias within SQuirreL for this driver.
5. Enter the **Example URL**. For HEAVY.AI, the required components are “jdbc”, “omnisci”, a valid DNS name for a machine running HEAVY.AI, the HEAVY.AI port number, and the name of the HEAVY.AI database. For example, `jdbc:heavyai:machine:9091:dbname`. If you are not sure of these values, contact your system administrator.
6. Enter the **Website URL**.
7. Enter the **Class Name**: `com.heavyai.jdbc.HeavyaiDriver`.
8. Click the **Extra Class Path** tab.
9. Click **Add** and navigate to the directory where `heavyaijdbc-<major_version>.<minor_version>.<revision>.jar`

   is located.
10. Click **Open**.
11. Click **OK**.

### Configure the HEAVY.AI Alias

1. Click **Aliases**.
2. Click **+** to add a new Alias.
3. Give the Alias a **Name**.
4. Choose *HEAVY.AI* as the **Driver**.
5. Update the example URL with the specific URL for your HEAVY.AI instance.
6. Enter your **User Name** and **Password**.
7. (Optional) Set **Auto Logon**.
8. (Optional) Set **Connect at Startup**.
9. Click **Test** to verify the connection.
10. Click **OK**.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.heavy.ai/v8.5.0/apis-and-interfaces/squirrel-sql.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.