Skip to main content

%JDBC Server

Define a JDBC gateway.


%JJDBC Server=JDBC,Port,[optional fields]


%JDBC Server is the name of the JDBC gateway definition in the default CPF, but additional JDBC gateways with different names can be created and existing gateways can be edited or deleted as described in [Gateways]. Each definition consists of a name followed by = and then a comma-separated list of values defining the gateway; some fields are required, and others can be left blank, in which case default values are used. Fields specific to JDBC (and other Java-based) gateways and those that can be used with all gateways are described in the following two sections. For a more detailed description, see Java External Server SetupOpens in a new tab and Defining External Server Configurations for JavaOpens in a new tab.

JDBC Gateway Fields

The first three fields in a JDBC gateway definition are common to all gateways and the next three are specific to Java-based gateways. These are shown in order in the following:

  • Type (required) — Type of the gateway. When defining a JDBC gateway, this is set to JDBC.

  • Port (required) — TCP port number for communication between the gateway and the proxy classes in InterSystems IRIS. This port number must not conflict with any other local TCP port on the server.

  • Resource — The gateway resourceOpens in a new tab that controls access to this gateway; for %JDBC Server in the default CPF, this is %Gateway_SQL.


    If no resource is specified, the gateway is public, but InterSystems strongly recommends protecting all gateways using this mechanism.

  • ClassPath — The files that must be passed as an argument when starting the Java Virtual Machine (JVM), which are typically the files containing the classes used via the gateway. The classpath must be properly quoted, with the correct platform-specific separators between files.

  • JVMArgs — Optional arguments passed to the JVM, used in the command to start the gateway.

  • JavaHome — Location of the JVM, used in the command to start the Gateway.


    This field is required unless a default JVM is set for the host system.

General Gateway Fields

The remaining eight fields can be used in any gateway definition, and are shown in the General Gateway Fields section under %DotNet Server.

Changing This Parameter

For information about changing and adding gateway definitions, see [Gateways].

FeedbackOpens in a new tab