JDBC - HEAVY.AI Docs

HeavyDB supports JDBC connections.
Resources
Resource
Description
JAR file
$OMNISCI_PATH/bin/omniscijdbc-<major_version>.<minor_version>.<revision>.jar
Code samples
$HEAVYAI_PATH/samples
JDBC driver
com.omnisci.jdbc.omnisciDriver
URL
jdbc:omnisci:<host>:[<keyvalue1>:<keyvalue2>:<keyvalue3>...][?<key1=value1>&<key2=value2>&<key3=value3>...]
You can connect securely to a JDBC session by defining the database URL (a colon-separated connection string with optional query string) and the keys/values in DriverManager.getConnection properties.
You can define key values separated by colons in the main part of the connection string , or as key/value pairs separated by an ampersand (&) in an optional query string following the ? character. 
jdbc:omnisci:<host_name> must be defined in the main part of the connection string. 
Valid keys in the connection URL are the same as those in the properties object. If defined in the main part of the connection string, they must appear in the following order:
host_name - Name of the host. Must be defined in the main part of the connection string.
port_num - Port number
db_name - Name of the database.
protocol: <binary|binary_tls|http|https|https_insecure>
To connect using a secure connection through binary mode, the HEAVY.AI server must be running with an encrypted main port open.
Use binary TLS mode to explicitly connect using SSL with the default Java trust stores.
To connect using HTTPS, the HEAVY.AI web server must be running with HTTPS enabled.
To create an encrypted connection with no server validation, use HTTPS_INSECURE.
Note: Using HTTPS_INSECURE is not recommended in a production environment.
For more information, see HEAVY.AI server configuration.
server_trust_store: trust_store_path - The path to a Java trust store holding the HEAVY.AI server public certificate.
server_trust_store_pwd: password - The password to the trust store.
pkiauth: true | false - Enable PKI authentication. If true:
The client X509 public certificate is supplied to the server for verification. Use the sslcert parameter to supply a file containing the certificate.
The user parameter and the password parameters are ignored and should be blank.
sslcert certificate-path - Path to the certificate and private key file, in PKCS12 format.
sslkey key-path - Path to the SSL key.
sslkey_password password - Password for the SSL key defined in sslkey key-path.
max_rows max_rows - The maximum number of rows to return.
Examples
You can use the following connection URLs to connect to an HEAVY.AI database called test_DB using port 6274 with max_rows set to 10000.
1
jdbc:omnisci:localhost:6274:test_DB?max_rows=10000
Copied!
1
jdbc:omnisci:localhost:6274?db_name=test_DB&max_rows=10000
Copied!
If duplicate information is supplied in different sources of connection information, sources have priority as follows:
1.The main part of the URL.
2.The query portion of the URL.
3.The Properties object.
In the following connection URL, the database test_DB would be used, and if logging is turned on, the driver would issue a warning:
1
jdbc:heayai:localhost:6274?dbname=test_DB&max_rows=10000&db_name=test_WRONGDB
Copied!
The fields in the "main" colon-separated portion of the URL are interpreted strictly in the order defined in the list of keys: host_name followed by port_num, followed by db_name, and so on. All of these fields can be specified in this portion of the connection string; however to specify a max_rows field this way, all the preceding values must also be specified. Empty fields are not allowed. In this case, consider using a Properties object or a the query string portion of the URL.
You can also provide all options and parameters for a JDBC connection in a Java properties file; for example:
1
server_trust_store=/tls_certs/server/trust_store_server.jks
2
server_trust_store_password=jks_truststore_password
3
pkiauth=true
4
sslcert=/tls_certs/client1_ca_primary_signed/client1.p12
5
sslkey_password=ssl_certfile_password
6
protocol=https
Copied!
Supported JDBC Methods
Method
Description
Connection class
​
clearWarnings
Clear all warnings reported for this connection object. After calling clearWarnings, calling getWarnings returns null until a new warning is reported for this connection object.
close
Disconnect the JDBC client session and frees associated resources.
createStatement
Get a new, empty Statement object.
getCatalog
Get the Connection object current catalog name.
getMetaData
Get a DatabaseMetaData object, which contains metadata about the database for which this Connection object represents a connection. The metadata includes information about the database tables, supported SQL grammar, stored procedures, and the capabilities of this connection.
getWarnings
Get the first warning reported by calls on this Connection object.
isClosed
Get the closed status of this Connection object:
true = connection closed
false = connection valid
isValid
Get the connection status:
true = valid connection
false = connection closed
prepareStatement
Create a PreparedStatement object. HeavyDB makes no distinction between prepared and directly executed statements and queries.
Driver
​
acceptsURL
Get the driver determination of whether or not it can open a connection to the URL.
connect
Make a database connection to the specified URL.
getMajorVersion
Get the driver major version number.
getMinorVersion
Get the driver minor version number.
getParentLogger
Get the parent Logger of all Loggers used by this driver.
getPropertyInfo
Get driver property information.
jdbcCompliant
Test if this driver is a JDBC-compliant driver.
Statement
​
Unsupported Features
Transaction statements
Cursors
Multiple result sets
Domains
Rules
Database procedures
Indexes
Keys
Constraints
Example
This example uses the JDBC interface to create a flight information database, then reads carrier information from the database.
Sequence
The key steps are:
1.Set connection parameters and credentials:
1
static final String JDBC_DRIVER = "com.omnisci.jdbc.omnisciDriver";
2
static final String DB_URL = "jdbc:omnisci:localhost:6274:omnisci";
3
static final String USER = "myUserName";
4
static final String PASS = "myPassWord";
Copied!
2.Register the JDBC driver:
1
Class.forName(JDBC_DRIVER);
Copied!
3.Open a HEAVY.AI server connection:
1
conn = DriverManager.getConnection(DB_URL, USER, PASS);
Copied!
4.Create a table, add data, and query the database:
1
stmt = conn.createStatement();
2
​
3
String sql = "CREATE table flights(arr_timestamp timestamp, dep_timestamp timestamp, uniquecarrier varchar(50))";
4
stmt.executeUpdate(sql);
5
​
6
sql = "insert into flights values('2017-04-23 06:30:0’, '2017-04-23 07:45:00’, 'Southwest’)";
7
stmt.executeUpdate(sql);
8
sql = "insert into flights values('2017-04-23 06:50:0’, '2017-04-23 09:45:00’, 'American’)";
9
stmt.executeUpdate(sql);
10
sql = "insert into flights values('2017-04-23 09:30:0’,’ 2017-04-23 12:45:00’, 'United’)";
11
stmt.executeUpdate(sql);
12
​
13
sql = "SELECT uniquecarrier from flights";
14
ResultSet rs = stmt.executeQuery(sql);
Copied!
5.Extract data from the result set:
1
while (rs.next()) {
2
    String uniquecarrier = rs.getString("uniquecarrier");
3
    System.out.println("uniquecarrier: " + uniquecarrier);
4
}
Copied!
Compile and Run
1
javac Flights.java
2
java -cp /home/omnisci/omnisci/bin/omnisci-jdbc-4.6.0.jar:./  Flights
Copied!
Source Code
1
import java.sql.Connection;
2
import java.sql.DriverManager;
3
import java.sql.ResultSet;
4
import java.sql.SQLException;
5
import java.sql.Statement;
6
​
7
public class Flights {
8
​
9
    static final String JDBC_DRIVER = "com.omnisci.jdbc.omnisciDriver";
10
    static final String DB_URL = "jdbc:omnisci:localhost:6274:omnisci";
11
    static final String USER = "myUserName";
12
    static final String PASS = "myPassWord";
13
​
14
    public static void main(String[] args) {
15
      Connection conn = null;
16
      Statement stmt = null;
17
      try {
18
        Class.forName(JDBC_DRIVER);
19
​
20
        conn = DriverManager.getConnection(DB_URL, USER, PASS);
21
​
22
        stmt = conn.createStatement();
23
        String sql = "CREATE table flights(arr_timestamp timestamp, dep_timestamp timestamp, uniquecarrier varchar(50))";
24
        stmt.executeUpdate(sql);
25
        sql = "insert into flights values('2017-04-23 06:30:0’, '2017-04-23 07:45:00’, 'Southwest’)";
26
        stmt.executeUpdate(sql);
27
        sql = "insert into flights values('2017-04-23 06:50:0’, '2017-04-23 09:45:00’, 'American’)";
28
        stmt.executeUpdate(sql);
29
        sql = "insert into flights values('2017-04-23 09:30:0’,’ 2017-04-23 12:45:00’, 'United’)";
30
        stmt.executeUpdate(sql);
31
​
32
        sql = "SELECT uniquecarrier from flights";
33
        ResultSet rs = stmt.executeQuery(sql);
34
​
35
        while (rs.next()) {
36
          String uniquecarrier = rs.getString("uniquecarrier");
37
          System.out.println("uniquecarrier: " + uniquecarrier);
38
        }
39
​
40
        rs.close();
41
        stmt.close();
42
        conn.close();
43
      } catch (SQLException se) {
44
        //Handle errors for JDBC
45
        se.printStackTrace();
46
      } catch (Exception e) {
47
        e.printStackTrace();
48
        if (stmt != null)
49
            stmt.close();
50
        if (conn != null)
51
            conn.close();
52
       }
53
    }
54
}
Copied!

APIs and Interfaces - Previous

Thrift

Next - APIs and Interfaces

ODBC

Last modified 1mo ago

Export as PDF

Copy link

Contents

Resources

Examples

Supported JDBC Methods