Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [SQL] >  [InboundProcAdapter]
Private  Storage   

class EnsLib.SQL.InboundProcAdapter extends EnsLib.SQL.InboundAdapter

SQL database-polling client adapter. Repeatedly executes a sql procedure against a remote database via an ODBC- or JDBC- defined DSN (Data Source Name) and processes each resulting row.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 9 3


Summary

Properties
%ClientIOAddr %IOAddr %JGConnectTimeout %JavaGateway
%WarnedLatest %logConnections BusinessHost CallInterval
ConnectAttrs ConnectTimeout Connected ConnectionAttributes
Credentials DSN DeleteQuery DoNotInterruptResultSet
EscapedCallRequiresBracing ExtraJGClasspaths IO IsUnicodeDLL
JDBCClasspath JDBCDriver JGClientConnectSpec JGClientEnsClassname
JGService KeepaliveInterval KeyFieldName MaxVarCharLengthAsString
OutputParamNames ParamSQLTypes Parameters Procedure
Query RegistryID StatementAttrs StayConnected
attrIDs updatecount

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AssignOneSetting BindOutputParameter ClearAllAppData ClearRuntimeAppData
ClearStaticAppData Commit Connect ConnectAttrsGet
ConnectAttrsSet ConnectJ ConnectedSet ConvertSQLTypeToInt
CredentialsSet DSNSet DescribeColumns DescribeParameters
Disconnect DisconnectJ DropResultSet DropStatement
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch ExecuteProcedure
ExecuteProcedureParmArray ExecuteQuery ExecuteQueryParmArray ExecuteUpdate
ExecuteUpdateParmArray Fetch FetchAhead GetArgLOBData
GetData GetDataW GetErrorList GetLastSQLCode
GetParameter GetPersistentValue GetSettings InitializeLastKeyValue
InitializePersistentValue JDBCClasspathSet MoreResults OnInit
OnKeepalive OnTask OnTearDown Rollback
RowCount SetAutoCommit SetConnectAttr SetConnectOption
SetPersistentValue SetStmtOption TestConnection TestConnectionJ
Transact addErrorList getConfigObj getProcedureParameters
initAdapterJG initJG isNetErr putLOBStream
putLOBStreams


Parameters

• parameter DOMAIN = "ENSEMBLE";
• parameter SETTINGS = "-Query,Procedure:Data,IO:Data,OutputParamNames:Data,-DoNotInterruptResultSet,EscapedCallRequiresBracing:Data";
These are the production settings for this object

Properties

• property EscapedCallRequiresBracing as %Boolean [ InitialExpression = 1 ];
JDBC escape call syntax requires the statement to be wrapped in {}
• property IO as %String;
A text string in which each character corresponds to one of the query parameters. The character 'i' means the corresponding parameter is an Input parameter. The character 'o' means it is an Output parameter, and 'b' means it is Both an Input and an Output parameter. If the procedure is a function which has a return value, an 'o' should be added in front to account for the return value.
• property OutputParamNames as %String(MAXLEN="");
A comma-separated list of property names corresponding to any output parameters of the procedure. If the procedure is a function, each parameter with an IO type of either 'o' or 'b' should have a name specified.
• property Procedure as %String(MAXLEN=1000);
The name of the procedure to be called by this Service. This should include any ? characters used to indicate parameters of the procedure, but should not include any SQL commands (eg. Select) with the exception that the CALL command must be included if ?= is used.
Specifying preceding ?=CALL is optional if the procedure provides a RETURN (Note the Input/Output Setting must include the leading o for the return.)
For example the following are valid:

schema.proc(?,?) with Input/Output of oii - this will result in ? = CALL schema.proc(?,?)
schema.proc(?,?) with Input/Output of ii - this will result in CALL schema.proc(?,?)
? = CALL schema.proc(?,?) with Input/Output of oii - this will result in ? = CALL schema.proc(?,?)
CALL schema.proc(?,?) with Input/Output of ii - this will result in CALL schema.proc(?,?)

Methods

• method OnInit() as %Status
This user callback method is called just after %OnNew()
• method OnTask() as %Status
Copied from EnsLib.SQL.InboundAdapter, except adjusted to use ExecuteProcedureParmArray and make use of IO and returned parameters


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.