Purpose

Specifies whether the driver's SQL engine runs in the same process as the driver (direct mode), runs in a process that is separate from the driver (server mode), or runs in a separate process that is monitored by the driver's Broker (Broker mode). You must be an administrator to modify the server mode configuration values, and to start or stop the SQL engine service.

Valid Values

Auto | Server | Direct | Broker

Behavior

If set to Auto, the SQL engine attempts to run in server mode first; however, if server mode is unavailable, it runs in direct mode. To use server mode with this value, you must start the SQL Engine service before using the driver.

If set to Server, the SQL engine runs in server mode. The SQL engine operates in a separate process from the driver within its own JVM. You must start the SQL Engine service before using the driver.

If set to Direct, the SQL engine runs in direct mode. The driver and its SQL engine run in a single process within the same JVM.

Important: Changes to the server-mode configuration affect all JDBC connections that use the same SQL Engine service.

If set to Broker, the SQL engine runs in Broker mode. The SQL engine operates in an external Java process that is monitored by the driver's Broker. To efficiently provision memory and resources, the Broker automatically starts and stops the service as needed. This setting also eliminates the need to manually start and stop the service.

Notes

  • If you are using server mode, you must start the SQL engine server before using the driver. Before starting the server, verify that you have the correct permissions to write to the directory specified by the Schema Map (SchemaMap) connection property.
  • The SQL engine runs in a Java process and can be launched using a java command with the following format:
java -Xmxheap_sizem -Dhttp.proxyHost=proxy_host 
-Dhttp.proxyPort=proxy_port -Dhttp.proxyUser=proxy_user
-Dhttp.proxyPassword=proxy_password -cp "jvm_classpath" 
com.ddtek.jdbc.mongodb.phoenix.sql.server.Server -port port_number

Data Source Methods

public String getSQLEngineMode()

public void setSQLEngineMode(String)

Default Value

Direct

Data Type

String