SQL Gateway Connections

InterSystems Programming Tools Index

[Home] [Back] [Next]

InterSystems: The power behind what matters

Caché Development References > InterSystems Programming Tools Index > Tools Index > SQL Gateway Connections

Class Reference

Search:

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

Background Information

The SQL Gateway allows Caché to access external databases via both JDBC and ODBC. For a detailed description of the SQL Gateway, see the chapter “Using the Caché SQL Gateway” in Using Caché SQL.

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

%SYSTEM.SQLGateway class

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.

%SQLConnection class

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

ConnExists()
setEncode()

It also provides the following class queries:

ByConnection()
ByName()

Availability: All namespaces.

Reminder

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