Skip to main content

%Library.SQLConnection

Class %Library.SQLConnection Extends (%Persistent, %XML.Adaptor) [ Not ProcedureBlock, SqlTableName = sys_SQLConnection, StorageStrategy = StorageSpec, System = 4 ]

Properties​

Name​

Property Name As %String(CAPTION = "Connection Name") [ Required, SqlFieldName = Connection_Name ];

Index for property Name

DSN​

Property DSN As %String(CAPTION = "DSN", MAXLEN = 256);

Usr​

Property Usr As %String(CAPTION = "User");

pwd​

Property pwd As %CSP.Util.Passwd(CAPTION = "Password", MAXLEN = "");

ReverseOJ​

Property ReverseOJ As %Boolean(CAPTION = "Legacy Sybase outer join syntax");

isJDBC​

Property isJDBC As %Boolean(CAPTION = "Is JDBC connection");

useCAST​

Property useCAST As %Boolean(CAPTION = "Use CAST as VARCHAR");

useCASTCHAR​

Property useCASTCHAR As %Boolean(CAPTION = "Use CAST as CHAR");

useCOALESCE​

Property useCOALESCE As %Boolean(CAPTION = "Use COALESCE") [ InitialExpression = 1 ];

URL​

Property URL As %String(CAPTION = "URL", MAXLEN = 4096);

driver​

Property driver As %String(CAPTION = "driver", MAXLEN = 256);

xadriver​

Property xadriver As %String(CAPTION = "driver", MAXLEN = 256);

classpath​

Property classpath As %Library.String(CAPTION = "Class Path", MAXLEN = 4096);

properties​

Property properties As %Library.String(CAPTION = "Properties", MAXLEN = 256);

nodefq​

Property nodefq As %Boolean(CAPTION = "Do not use delimited identifiers by default");

noconcat​

Property noconcat As %Boolean(CAPTION = "Do not generate {fn concat()}");

nofnconv​

Property nofnconv As %Boolean(CAPTION = "Do not generate {fn conv ...} by default");

needlongdatalen​

Property needlongdatalen As %Boolean(CAPTION = "Needs long data length");

nvl​

Property nvl As %Boolean(CAPTION = "Use NVL() instead of IFNULL()");

bUnicodeStream​

Property bUnicodeStream As %Boolean(CAPTION = "Supports Unicode Streams") [ InitialExpression = 1 ];

tpw​

Property tpw As %String [ Private, Transient ];

bEncode​

Property bEncode As %Boolean [ InitialExpression = 1, Private, Transient ];

bindTSasString​

Property bindTSasString As %Boolean(CAPTION = "Bind TIMESTAMP parameters as VARCHAR") [ InitialExpression = 0 ];

Bind TIMESTAMP type parmaters as VARCHAR. When binding parameter values via the GateWay, some remote systems consider TIMESTAMP as a special structure that does not match the the %TimeStamp datatype format of YYYY-MM-DD HH24:MI;SS[.ssssss]. Setting this property to 1 will bind TIMESTAMP parameters as VARCHARs instead of TIMESTAMP. You might need this setting when binding TIMESTAMP parameters to Oracle, depending on the Oracle driver used.

OnConnectStatement​

Property OnConnectStatement As %String(CAPTION = "Statement to execute upon connection", MAXLEN = 4096);

Statement to execute on remote system immediately after connection. This is only for a Gateway conenction through %Library.GTWConnection.Connect() method. An example usage of this would be to set a session parameter on an Oracle connection: ALTER SESSION SET NLS_TIMESTAMP_FORMAT = 'YYYY-MM-DD HH24:MI:SS.FF6'

disconnectOnClose​

Property disconnectOnClose As %Boolean(CAPTION = "Close the connection after each user of the connection in one process closes") [ InitialExpression = 0 ];

This property determines whether or not to close the gateway connection after all users of this connection (linked table queries or %SQLGatewayConnection objects) have closed. This is tracked per-process.

Methods​

setEncode​

Method setEncode(val As %Boolean)

ConnExists​

ClassMethod ConnExists(nm As %String) As %Boolean

%OnBeforeSave​

Method %OnBeforeSave(insert As %Boolean) As %Status [ Private ]

Lookup by Connection name Lookup by Connection name without input parameter This callback method is invoked by the %Save method to provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save will fail.

%OnAfterSave​

Method %OnAfterSave(insert As %Boolean) As %Status [ Private ]

This callback method is invoked by the %Save method to provide notification that the object is being saved. It is called after the object's data has been successfully written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save will fail.