Configuring the SQL Workbench Client

Recommended method - Fresh install
(Windows x64)

  1. Download the latest installer from this URL:
    and follow the installation wizard instructions.
    You can also follow the instructions in the KB article Installing the SQream ODBC Driver, but do not deselect the JDBC and SQL Workbench sections.

  2. You should now have a Start menu item for SQL Workbench: Hit the Windows button on the screen or on your keyboard, and type SQL Workbench. Select either 64 bit or 32 bit variant, depending on your preference.

  3. Open SQL Workbench. You should be facing a New Connection window, with the SQream driver already selected.

    Fill in the connection string, as given to you by our staff.
  4. You are now ready to start querying data!

Configuring an existing Workbench installation manually (Linux/MacOS):

  1. Install SQL Workbench according to the instructions relevant to your OS.
  2. Obtain the SQream JARs, and unpack them into a directory of your choice. You can obtain the latest JARs from this URL:
  3. Open SQL Workbench, and define a connection profile:
  4. Click File -> Connect window (Alt+C)
  5. Click on Manage Drivers

  6. From the Manage Drivers window:
    1. Click on the Add new driver button (white paper icon)
    2. Name the driver as you see fit
    3. Add the JDBC drivers from the location where your JARs exist. If you used the SQream installer, they should be located in 
      C:\Program Files\SQream Technologies\JDBC Driver\
    4. The classname should appear as sql.SQDriver automatically
    5. Click OK to save and return to "new connection screen"

Create a connection to your service/DB:

    1. Create new connection
    2. Choose a connection name as you see fit
    3. Select the SQream Driver you just created in the previous screen
    4. Type in the JDBC url as was sent to you. Typically:
      jdbc:Sqream://<ip>:<port>/<db_name>;user=<user>;password=<pass>;cluster=<true or false>;
    5. Save the connection settings
    6. Click OK to connect your service/DB


Suggested additional steps you may preform after closing SQL workbench:

  1. Locate your workbench.settings file.
    On Windows, typically: %HOMEPATH%\.sqlworkbench\workbench.settings
    On *nix, $HOME/.sqlworkbench
  2. Add following line at the end of the file:
  • 74
  • 20-Aug-2017