SQLGateway Class Reference

The <class>SYSTEM.SQLGateway</class> class provides an interface for managing Gateway connections. More...

Inheritance diagram for SQLGateway:

Collaboration diagram for SQLGateway:

Static Public Member Functions
_.Library.Status	DropAll ()
	The <class>SYSTEM.SQLGateway</class> class provides an interface for managing Gateway connections. More...
_.Library.Status	DropConnection (nm)
	Disconnect a JDBC or ODBC connection. More...
_.Library.Binary	GetJDBCConnection (cname)
	Connect to a previously defined JDBC Gateway connection. More...
_.Library.Binary	GetODBCConnection (nm, timeout, legacy)
	Connect to a previously defined SQL Gateway ODBC connection. More...
_.Library.Status	SetAllODBCConnectOption (option, vparm)
	Set the given integer option for all open connections. More...
_.Library.Status	SetAutoCommit (ac)
	Set the autocommit mode for all open connections. More...
_.Library.Status	TestConnection (nm, timeout, verbose, error)
	Test a previously defined SQL Gateway connection. More...
_.Library.Status	Transact (ttype)
	Request a commit or rollback operation for all active operations on JDBC or ODBC connections. More...
Static Public Member Functions inherited from Help
_.Library.String	Help (_.Library.String method)
	This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...

Detailed Description

The <class>SYSTEM.SQLGateway</class> class provides an interface for managing Gateway connections.

You can use it via the special $system object:

Do $system.SQLGateway.DropAll()

Member Function Documentation

DropAll()

_.Library.Status DropAll ( )

static

The <class>SYSTEM.SQLGateway</class> class provides an interface for managing Gateway connections.

You can use it via the special $system object:

Do $system.SQLGateway.DropAll()

Drop all open connections and unload the SQL Gateway library.

DropConnection()

_.Library.Status DropConnection (   nm )

static

Disconnect a JDBC or ODBC connection.

nm - connection name

GetJDBCConnection()

_.Library.Binary GetJDBCConnection (   cname )

static

Connect to a previously defined JDBC Gateway connection.

It returns an empty string if the connection attempt was unsuccessful.

nm - connection name

GetODBCConnection()

_.Library.Binary GetODBCConnection (   nm,   timeout,   legacy  )

static

Connect to a previously defined SQL Gateway ODBC connection.

It returns an empty string if the connection attempt was unsuccessful.

nm - connection name
timeout - timeout
legacy - legacy mode

SetAllODBCConnectOption()

_.Library.Status SetAllODBCConnectOption (   option,   vparm  )

static

Set the given integer option for all open connections.

option - option to set
vparm - value associated with option

SetAutoCommit()

_.Library.Status SetAutoCommit (   ac )

static

Set the autocommit mode for all open connections.

ac = { 0 - AUTOCOMMIT OFF, 1 - AUTOCOMMIT ON}

TestConnection()

_.Library.Status TestConnection (   nm,   timeout,   verbose,   error  )

static

Test a previously defined SQL Gateway connection.

It writes the diagnostic ouput to a current device.

nm - connection name
timeout - timeout (only relevant for ODBC connections)
verbose - setting to a non 0 value will cause the diagnostic output to the current device
error - output variable for passing back an error if it occurs

Transact()

_.Library.Status Transact (   ttype )

static

Request a commit or rollback operation for all active operations on JDBC or ODBC connections.

type = { 0 - SQL_COMMIT, 1 - SQL_ROLLBACK}