SQuirreL Client

1. Introduction

The SQuirreL SQL Client uses JDBC to allow users to explore and interact with databases via a JDBC driver.

It provides an editor that offers code completion and syntax highlighting for standard SQL.

Plugin’s can be added to modify the application’s behavior and to add database-specific functionality.

SQuirreL SQL is written in Java with Swing UI, and so should run on any platform with a JVM.

1.1. License

SQuirreL SQL Client is free as open source software that is distributed under the GNU Lesser General Public License.

1.2. Version

In this guide, we are using version 4.1.0 of SQuirreL SQL Client. If you wish to use a different version, please pay attention to when the version number is used in the instructions.

2. Installation

2.1. Download

Table 1. Download options

OS

Download Link

Linux / Windows

https://sourceforge.net/projects/squirrel-sql/files/1-stable/4.1.0/squirrel-sql-4.1.0-standard.jar/download

macOS

https://sourceforge.net/projects/squirrel-sql/files/1-stable/4.1.0/squirrel-sql-4.1.0-MACOSX-install.jar/download

A list of plugins is available at http://www.squirrelsql.org/index.php?page=plugins

Generally, installation is done by running the installer from the command line with a java -jar squirrel-sql-<version>-install.jar type command. For details, see below.

To install SquirreL SQL:

  • Open a console/command line window

  • Decide which directory you want to install into

  • Make sure that you have write access to that directory

2.2. Installing on Linux

  • Run the .jar installer:

    java -jar squirrel-sql-4.1.0-standard.jar
  • Follow the installation guide:

start

info

dir

target

progress

scripts

script_install

shortcuts

2.2.1. Run Client

To start the client, use the provided startup script in the installation directory.

.\squirrel-sql.sh

The application opens, by default together with the help window.

2.2.2. What’s next

With the application installed, you can now add the LeanXcale drivers.

2.3. Installing on macOS

  • Run the .jar installer:

    java -jar squirrel-sql-4.1.0-MACOSX-install.jar
  • Follow the installation guide:

start

info

dir

target

progress

scripts

script_install

shortcuts

2.3.1. Run Client

To start the client, use the provided startup script in the installation directory:

squirrel-sql.sh

2.4. Installing on Windows

  • Run the .jar installer :

    java -jar squirrel-sql-4.1.0-standard.jar
  • Follow the installation guide:

start

info

dir

target

progress

scripts

script_install

shortcuts

2.4.1. Run Client

To start the client, use the provided startup script in the installation directory:

squirrel-sql.bat

3. Install JDBC driver

You can download the Java JDBC driver for LeanXcale from the Drivers page.

To install the driver:

  • Find the SQuirreL install directory and the lib directory inside it

  • Copy the .jar file you downloaded and paste it into the lib directory

When the driver has been placed in the lib directory, it is shown as active in the SQuirrel interface (a blue tick mark).

  • Open SQuirreL

  • Click Drivers

active_driver

If you don’t have a CQE Driver option, add it and check it has the following data:

options

The important data is the class: com.leanxcale.client.Driver

  • Click OK

The driver is registered:

registered

You can now set up the connection.

4. Connect to LeanXcale

In SQuirrel SQL, a database connection is called an Alias and are set up in the Alias tab.

The general format for the connection string is:

jdbc:sqlserver://[serverName[\instanceName][:portNumber]][;property=value[;property=value]]

5. Setting up a connection

The connection string for LeanXcale CQE Driver is:

jdbc:leanxcale://{Your server name or IP address}:{Port}/{Your database}

Typically you will have it installed on port 1529. The image below shows an example of a connection setting:

Connection example