JDBC

The SQream DB JDBC driver allows many Java applications and tools connect to SQream DB. This tutorial shows how to write a Java application using the JDBC interface.

The JDBC driver requires Java 1.8 or newer.

Installing the JDBC Driver

Prerequisites

The SQream JDBC driver requires Java 1.8 or newer. We recommend either Oracle Java or OpenJDK.

Oracle Java

To download and install Java 8 from Oracle for your platform, see Java Downloads for All Operating Systems.

OpenJDK

For Linux and BSD, see How to download and install prebuilt OpenJDK packages.

For Windows, SQream recommends Zulu 8.

Getting the JAR file

The JDBC driver is provided as a zipped JAR file, available for download from the client drivers download page. This JAR file can integrate into your Java-based applications or projects.

Extract the ZIP Archive

Extract the JAR file from the zip archive

$ unzip sqream-jdbc-4.3.0.zip

Setting Up the Class Path

To use the driver, the JAR named sqream-jdbc-<version>.jar (for example, sqream-jdbc-4.3.0.jar) needs to be included in the class path, either by putting it in the CLASSPATH environment variable, or by using flags on the relevant Java command line.

For example, if the JDBC driver has been unzipped to /home/sqream/sqream-jdbc-4.3.0.jar, the application should be run as follows:

$ export CLASSPATH=/home/sqream/sqream-jdbc-4.3.0.jar:$CLASSPATH
$ java my_java_app

An alternative method is to pass -classpath to the Java executable:

$ java -classpath .:/home/sqream/sqream-jdbc-4.3.0.jar my_java_app

Connect to SQream DB with a JDBC Application

Driver Class

Use com.sqream.jdbc.SQDriver as the driver class in the JDBC application.

Connection String

JDBC drivers rely on a connection string.

The following is the correct syntax for writing a connection string:

jdbc:Sqream://<host and port>/<database name>;user=<username>;password=<password>sqream;[<optional parameters>; ...]

If you receive an error when saving large quantities of data as files, see Troubleshooting - Error Saving Large Quantities of Data as Files.

Connection Parameters

Item	Optional	Default	Description
<host and port>	✗	None	Hostname and port of the SQream DB worker. For example, 127.0.0.1:5000, sqream.mynetwork.co:3108
<database name>	✗	None	Database name to connect to. For example, master
username=<username>	✗	None	Username of a role to use for connection. For example, username=rhendricks
password=<password>	✗	None	Specifies the password of the selected role. For example, password=Tr0ub4dor&3
service=<service>	✓	sqream	Specifices service queue to use. For example, service=etl
<ssl>	✓	false	Specifies SSL for this connection. For example, ssl=true
<cluster>	✓	true	Connect via load balancer (use only if exists, and check port).

Connection String Examples

For a SQream DB cluster with load balancer and no service queues, with SSL

jdbc:Sqream://sqream.mynetwork.co:3108/master;user=rhendricks;password=Tr0ub4dor&3;ssl=true;cluster=true

Minimal example for a local, standalone SQream DB

jdbc:Sqream://127.0.0.1:5000/master;user=rhendricks;password=Tr0ub4dor&3

For a SQream DB cluster with load balancer and a specific service queue named etl, to the database named raviga

jdbc:Sqream://sqream.mynetwork.co:3108/raviga;user=rhendricks;password=Tr0ub4dor&3;cluster=true;service=etl

Sample Java Program

Download this file by right clicking and saving to your computer sample.java.

JDBC application sample

import java.sql.Connection;  
import java.sql.DatabaseMetaData;  
import java.sql.DriverManager;  
import java.sql.Statement;  
import java.sql.ResultSet;  

import java.io.IOException;  
import java.security.KeyManagementException;  
import java.security.NoSuchAlgorithmException;  
import java.sql.SQLException;  



public  class  SampleTest  {  

    // Replace with your connection string
    static  final  String  url  =  "jdbc:Sqream://sqream.mynetwork.co:3108/master;user=rhendricks;password=Tr0ub4dor&3;ssl=true;cluster=true";  

    // Allocate objects for result set and metadata
    Connection  conn    =  null;  
    Statement  stmt  =  null;  
    ResultSet  rs  =  null;  
    DatabaseMetaData  dbmeta  =  null;  

    int  res  =  0;  

    public  void  testJDBC()  throws  SQLException,  IOException  {  

        // Create a connection
        conn  =  DriverManager.getConnection(url,"rhendricks","Tr0ub4dor&3");  

        // Create a table with a single integer column
        String sql  =  "CREATE TABLE test (x INT)";
        stmt = conn.createStatement();  // Prepare the statement
        stmt.execute(sql); // Execute the statement
        stmt.close(); // Close the statement handle

        // Insert some values into the newly created table
        sql = "INSERT INTO test VALUES (5),(6)";
        stmt = conn.createStatement();
        stmt.execute(sql);
        stmt.close();

        // Get values from the table
        sql = "SELECT * FROM test";
        stmt = conn.createStatement();
        rs  = stmt.executeQuery(sql);
        // Fetch all results one-by-one
        while(rs.next()) {
            res = rs.getInt(1);
            System.out.println(res); // Print results to screen
        }
        rs.close(); // Close the result set
        stmt.close(); // Close the statement handle
    }


    public  static  void  main(String[]  args)  throws  SQLException,  KeyManagementException,  NoSuchAlgorithmException,  IOException,  ClassNotFoundException{  

        // Load SQream DB JDBC driver
        Class.forName("com.sqream.jdbc.SQDriver");  

        // Create test object and run
        SampleTest  test  =  new  SampleTest();  
        test.testJDBC();  
    }  
}