Skip to main content

SQL Gateway Connections (Tools/APIs)

Manage and access SQL Gateway connections programmatically (check connections, query by name, and so on).

Background Information

The SQL Gateway allows InterSystems IRIS® data platform to access external databases via both JDBC and ODBC. For a detailed description of the SQL Gateway, see Using the InterSystems SQL Gateway.

An SQL Gateway connection contains information about accessing a specific external database via JDBC or via ODBC. You generally define these connections in the Management Portal.

Available Tools

Provides an interface for managing SQL Gateway connections. This class provides methods like the following:

  • DropConnection()

  • GetJDBCConnection()

  • GetODBCConnection()

  • SetAutoCommit()

  • Test()

  • And others

Availability: All namespaces.

Stores SQL Gateway connections. This class provides the following methods:

  • ConnExists()

  • setEncode()

It also provides the following class queries:

  • ByConnection()

  • ByName()

Availability: All namespaces.


The special variable $SYSTEM is bound to the %SYSTEM package. This means that instead of ##class(%SYSTEM.class).method(), you can use $SYSTEM.class.method().

FeedbackOpens in a new tab