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. For more information, see http://www.gnu.org/licenses/licenses.html#LGPL.

1.2. Version

In this guide, we are using version 3.9.1 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. Download

3. Installation

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

3.1. Linux

  • Run the installer .jar:

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

start

info

dir

target

progress

scripts

script_install

shortcuts

4. Run Client

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

4.1. Linux

In the console:

.\squirrel-sql.sh

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

5. What’s next

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

6. Connection drivers

In order to connect to LeanXcale, you need to install the JDBC driver .jar files.

You do need to install both the elasticdriver and l18n files.

7. Download JDBC driver

The JDBC driver can be downloaded from:

8. Install JDBC driver

To install the JDBC driver:

  • Expand/extract the downloaded archive

  • Copy the .jar file from the expanded

  • Find the SQuirrel SQL install directory

  • Open the lib directory

  • Paste the .jar file into the lib directory

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

  • Open SQuirrel SQL

  • Click Drivers

active_driver

  • Select the Apache Derby Client

  • Double click the entry

The configuration shows the driver options:

options

  • Click OK

The driver is registered:

registered

You can now set up the connection.

9. 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]]====

10. Setting up a connection