Before you begin:In server mode, you must start the SQL engine server before using the driver.

The following sections describe how to configure, start, and stop the SQL engine server on Linux platform.

Note: By default, SQL Engine Mode is set to 1 (Server) for Windows and 2 (Direct) for Linux.

To configure the SQL engine server, specify values for the Java options in the following JVM argument to suit your environment. See the "SQL engine server Java options" table for a description of these options. 

java -Xmx<heap_size>m -cp "<jvm_classpath>" com.ddtek.jdbc.<driver>.phoenix.sql.Server 
        -port <port_number> -Dhttp.proxyHost=<proxy_host> -Dhttp.proxPort=<proxy_port> 
        -Dhttp.proxyUser=<proxy_user> -Dhttp.proxyPassword=<proxy_password>

For example:

java -Xmx1024m -cp "/opt/Progress/DataDirect/ODBC_80_64bit/java/lib/sforce.jar" 
      com.ddtek.phoenix.sql.Server -port 19937 -Dhttp.proxyHost=myhost@mydomain.com 
      -Dhttp.proxPort=12345 -Dhttp.proxyUser=JohnQPublic -Dhttp.proxyPassword=secret

To start the SQL engine service, execute the JVM Argument after configuring the Java options. A confirmation message is returned once the server is online.

Note: After the initial configuration, in order for changes to these connection option values to take effect, you must restart the SQL engine server.
Table 1. SQL engine server Java options
Java Option Description
Required Java Options

-cp

Specifies the CLASSPATH for the Java Virtual Machine (JVM) used by the driver. The CLASSPATH is the search string the JVM uses to locate the Java jar files the driver needs. The driver's JVM is located on the following path:

install_dir/java/lib/sforce.jar

-port

Specifies a valid port on which the SQL engine listens for requests from the driver. We recommend specifying one of the following values:

  • 19938 (32-bit drivers)
  • 19937 (64-bit drivers)
Optional Java Options

-Xmx

Specifies the maximum memory heap size, in megabytes, for the JVM. The default size is determined by your JVM. We recommend specifying a size no smaller than 1024.

Note: Although this option is not required to start the SQL engine server, we highly recommend specifying a value.

-Dhttp.proxyHost

Specifies the host name of the proxy server. The value specified can be a host name, a fully qualified domain name, or an IPv4 or IPv6 address.

-Dhttp.proxyPort

Specifies the port number where the proxy server is listening for HTTP and/or HTTPS requests.

-Dhttp.proxyUser

Specifies the user name needed to connect to the proxy server.

-Dhttp.proxyPassword

Specifies the password needed to connect to the proxy server.