iConn
- class iConn(db, user, pwd, restConfig)
Note
Deprecated: Replaced by
Connection
and will be removed in the next major version.Creates a new iConn object.
- Arguments
db (string) – The database to connect to.
user (string) – The user to connect as.
pwd (string) – The user’s password.
restConfig (restConfig) – The rest transport config.
- iConn.add(xml)
Note
Deprecated: Replaced by
Connection.add()
and will be removed in the next major version.Adds XML to the command list. When an instance of iPgm or iSql is passed
.toXML()
is invoked to return the underlying xml.- Arguments
xml (string|object) – The xml to add to the command list.
- iConn.debug(flag)
Note
Deprecated: Replaced by
Connection.debug()
and will be removed in the next major version.Enables or disables the verbose mode for debugging.
- Arguments
flag (boolean) – Whether to enable verbose output.
- Returns
boolean – The current state of the debug flag.
- iConn.getConnection()
Note
Deprecated: Replaced by
Connection.getTransportOptions()
and will be removed in thenext major version.
Returns conn property from iConn object.
- Returns
object – the conn property from iConn object.
- iConn.run(callback)
Note
Deprecated: Replaced by
Connection.run()
and will be removed in the next major version.Invokes transport with XML generated from joining the command list. Note the command list is cleared after calling this function. Once the transport is complete the user provided callback function is called.
- Arguments
callback (runCallbackDeprecated) – The callback function.
- restConfig()
Deprecated rest transport configuration
- Arguments
host (string) – The hostname of the server. Default is
localhost
.ipc (string) – The key name/security route to XMLSERVICE job. Default is
*NA
.ctl (string) – The control options for XMLSERVICE jobs. Defaults is
*here
.port (number) – The port on the server. Default is
80
.path (string) – The path to xmlcgi endpoint. Default is
/
.
- runCallbackDeprecated(xmlOutput)
- Arguments
xmlOutput (string) – the xml output.