Before you begin: If you are using server mode, you must start the SQL engine server before connecting. Before starting the SQL engine server, choose a directory to store the local database files using the Schema Map (SchemaMap) option. Make sure that you have the correct permissions to write to this directory.
Note: The Configuration Manager is currently supported only on Windows platforms. To configure the SQL engine on UNIX/Linux platforms, see "Configuring Broker mode for the SQL engine server on UNIX/Linux" or "Configuring the SQL engine server using Java options."

The following sections describe how to configure and start the SQL engine server using the Configuration Manager.

  1. Open your data source using the Configuration Manager; then, select the SQL Engine tab.
  2. Set the SQL Engine Mode (SQLEngineMode) connection option to one of the following values:
    • 0 - Auto: The SQL engine attempts to run in server mode first, but will failover to direct mode if server mode is unavailable.
    • 1 - Server: The SQL engine runs exclusively in server mode.
    • 3 - Broker: The SQL engine runs exclusively in Broker mode.
    Note: By default, SQL Engine Mode is set to 1 - Server for Windows and 2 - Direct for UNIX/Linux.
    The fields associated with server mode will become exposed, and the Start button appears.
  3. Provide values for the following options:

    For server mode only:

    • Server Port Number: Specifies a valid port on which the SQL engine listens for requests from the driver. The default value depends on your platform:

      32-bit: 19968

      64-bit: 19967

    For Broker mode only:

    • Broker Port Number: Specifies a valid port on which the Broker listens for client connection requests. The default value is 1183.

    • Max Connections Per Server: Specifies the number of connections that can be granted to a server before another server is created. The default value is 1024 connections.

    • Server Launch Timeout: Specifies the number of seconds the Broker waits for a server process to initialize before determining that is not available. The default value is 30 seconds.

    • Server Idle Timeout: Specifies the number of seconds the SQL engine server can be without active connections before the Broker issues a SHUTDOWN command to stop the server. The default value is 300 seconds.

    • Broker Idle Timeout: Specifies the number of seconds the Broker continues to run after all the SQL engine servers have been stopped (shutdown). This option allows for the Broker to shut itself down while there are no active connections to the database. When a new connection request is made by the application, the Broker restarts itself and spawns a SQL engine process to serve the database requests made through the driver. The default value is 600 seconds.

    • Broker Ping Interval: Specifies the number of seconds between status heartbeats from a SQL engine server process to the Broker. The default value is 30 seconds.

    For server and Broker mode:

    • JVM Path: Specifies fully qualified path to the Java SE 8 or higher JVM executable that you want to use to run the SQL engine server. The path must not contain double quotation marks. The default value is: 

      install_dir\jre\bin\java.exe
    • JVM Arguments: A string that contains the arguments that are passed to the JVM that the driver is starting. The location of the JVM must be specified on your PATH. See "JVM Arguments" for details. The following are the default values:
      • For the 32-bit driver in direct or Broker mode: -Xmx256m
      • For all other configurations: -Xmx1024m

    • JVM Classpath: Specifies the CLASSPATH for the JVM used by the driver. See "JVM Classpath" for details.

    Note: After the initial configuration, in order for changes to the required and optional connection option values to take effect, you must restart the SQL engine server.
  4. Click Save to save your changes
  5. Start the SQL engine service:
    • Auto or server mode: Click Start to run the SQL engine service A message is displayed that indicates whether the SQL engine was able to successfully run.
    • Broker mode: The SQL engine service automatically launches when you establish a connection.
You have configured and started your SQL engine server.