Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Properties (20)
Methods (2)
Queries (2)
Indexes (2)
Inherited Members
Storage

Show private members

%Library.SQLConnection

persistent class %Library.SQLConnection extends %Library.Persistent, %XML.Adaptor

SQL Table Name: %Library.sys_SQLConnection

Property Inventory

DSN
Name
ReverseOJ
URL
Usr
bUnicodeStream
classpath
driver
isJDBC
needlongdatalen
noconcat
nodefq
nofnconv
nvl
properties
pwd
useCAST
useCASTCHAR
useCOALESCE
xadriver

Properties

property DSN as %String (CAPTION = "DSN", MAXLEN = 256);

Property methods: DSNDisplayToLogical(), DSNGet(), DSNGetStored(), DSNIsValid(), DSNLogicalToDisplay(), DSNLogicalToOdbc(), DSNNormalize(), DSNSet()

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

Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()

property ReverseOJ as %Boolean (CAPTION = "Legacy Sybase outer join syntax");

Property methods: ReverseOJDisplayToLogical(), ReverseOJGet(), ReverseOJGetStored(), ReverseOJIsValid(), ReverseOJLogicalToDisplay(), ReverseOJLogicalToXSD(), ReverseOJNormalize(), ReverseOJSet(), ReverseOJXSDToLogical()

property URL as %String (CAPTION = "URL", MAXLEN = 4096);

Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()

property Usr as %String (CAPTION = "User");

Property methods: UsrDisplayToLogical(), UsrGet(), UsrGetStored(), UsrIsValid(), UsrLogicalToDisplay(), UsrLogicalToOdbc(), UsrNormalize(), UsrSet()

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

Property methods: bUnicodeStreamDisplayToLogical(), bUnicodeStreamGet(), bUnicodeStreamGetStored(), bUnicodeStreamIsValid(), bUnicodeStreamLogicalToDisplay(), bUnicodeStreamLogicalToXSD(), bUnicodeStreamNormalize(), bUnicodeStreamSet(), bUnicodeStreamXSDToLogical()

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

Property methods: classpathDisplayToLogical(), classpathGet(), classpathGetStored(), classpathIsValid(), classpathLogicalToDisplay(), classpathLogicalToOdbc(), classpathNormalize(), classpathSet()

property driver as %String (CAPTION = "driver", MAXLEN = 256);

Property methods: driverDisplayToLogical(), driverGet(), driverGetStored(), driverIsValid(), driverLogicalToDisplay(), driverLogicalToOdbc(), driverNormalize(), driverSet()

property isJDBC as %Boolean (CAPTION = "Is JDBC connection");

Property methods: isJDBCDisplayToLogical(), isJDBCGet(), isJDBCGetStored(), isJDBCIsValid(), isJDBCLogicalToDisplay(), isJDBCLogicalToXSD(), isJDBCNormalize(), isJDBCSet(), isJDBCXSDToLogical()

property needlongdatalen as %Boolean (CAPTION = "Needs long data length");

Property methods: needlongdatalenDisplayToLogical(), needlongdatalenGet(), needlongdatalenGetStored(), needlongdatalenIsValid(), needlongdatalenLogicalToDisplay(), needlongdatalenLogicalToXSD(), needlongdatalenNormalize(), needlongdatalenSet(), needlongdatalenXSDToLogical()

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

Property methods: noconcatDisplayToLogical(), noconcatGet(), noconcatGetStored(), noconcatIsValid(), noconcatLogicalToDisplay(), noconcatLogicalToXSD(), noconcatNormalize(), noconcatSet(), noconcatXSDToLogical()

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

Property methods: nodefqDisplayToLogical(), nodefqGet(), nodefqGetStored(), nodefqIsValid(), nodefqLogicalToDisplay(), nodefqLogicalToXSD(), nodefqNormalize(), nodefqSet(), nodefqXSDToLogical()

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

Property methods: nofnconvDisplayToLogical(), nofnconvGet(), nofnconvGetStored(), nofnconvIsValid(), nofnconvLogicalToDisplay(), nofnconvLogicalToXSD(), nofnconvNormalize(), nofnconvSet(), nofnconvXSDToLogical()

property nvl as %Boolean (CAPTION = "Use NVL() instead of IFNULL()");

Property methods: nvlDisplayToLogical(), nvlGet(), nvlGetStored(), nvlIsValid(), nvlLogicalToDisplay(), nvlLogicalToXSD(), nvlNormalize(), nvlSet(), nvlXSDToLogical()

property properties as %Library.String (CAPTION = "Properties", MAXLEN = 256);

Property methods: propertiesDisplayToLogical(), propertiesGet(), propertiesGetStored(), propertiesIsValid(), propertiesLogicalToDisplay(), propertiesLogicalToOdbc(), propertiesNormalize(), propertiesSet()

property pwd as %CSP.Util.Passwd (CAPTION = "Password");

Property methods: pwdDisplayToLogical(), pwdGet(), pwdGetStored(), pwdIsValid(), pwdLogicalToDisplay(), pwdLogicalToOdbc(), pwdNormalize(), pwdSet()

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

Property methods: useCASTDisplayToLogical(), useCASTGet(), useCASTGetStored(), useCASTIsValid(), useCASTLogicalToDisplay(), useCASTLogicalToXSD(), useCASTNormalize(), useCASTSet(), useCASTXSDToLogical()

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

Property methods: useCASTCHARDisplayToLogical(), useCASTCHARGet(), useCASTCHARGetStored(), useCASTCHARIsValid(), useCASTCHARLogicalToDisplay(), useCASTCHARLogicalToXSD(), useCASTCHARNormalize(), useCASTCHARSet(), useCASTCHARXSDToLogical()

property useCOALESCE as %Boolean (CAPTION = "Use COALESCE") [ InitialExpression = 1 ];

Property methods: useCOALESCEDisplayToLogical(), useCOALESCEGet(), useCOALESCEGetStored(), useCOALESCEIsValid(), useCOALESCELogicalToDisplay(), useCOALESCELogicalToXSD(), useCOALESCENormalize(), useCOALESCESet(), useCOALESCEXSDToLogical()

property xadriver as %String (CAPTION = "driver", MAXLEN = 256);

Property methods: xadriverDisplayToLogical(), xadriverGet(), xadriverGetStored(), xadriverIsValid(), xadriverLogicalToDisplay(), xadriverLogicalToOdbc(), xadriverNormalize(), xadriverSet()

Methods

classmethod ConnExists(nm As %String) as %Boolean

method setEncode(val As %Boolean)

Queries

query ByConnection()

Selects Connection_Name, DSN, User, ID

SQL Query:
SELECT Connection_Name, DSN, usr, %ID FROM %Library.sys_SQLConnection WHERE Connection_Name is not null ORDER BY Connection_Name

Lookup by Connection name without input parameter

query ByName(name As %String = "")

Selects Connection_Name, DSN, User, ID, isJDBC

SQL Query:
SELECT Connection_Name, DSN, usr, %ID, isJDBC FROM %Library.sys_SQLConnection WHERE Connection_Name %STARTSWITH %ALPHAUP(:name) ORDER BY Connection_Name

Lookup by Connection name

Indexes

index (IDKEY on ) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

index (NameIndex on Name) [Unique];

Index for property Name

Index methods: NameIndexCheck(), NameIndexCheckUnique(), NameIndexDelete(), NameIndexExists(), NameIndexOpen(), NameIndexSQLCheckUnique(), NameIndexSQLExists(), NameIndexSQLFindPKeyByConstraint(), NameIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: CacheStorage (%Library.SQLConnection)

^%SYS("sql","ODBCCONNECTION","DATA")(ID)

%%CLASSNAME

DSN

Name

Usr

pwd

ReverseOJ

isJDBC

URL

driver

classpath

properties

useCAST

xadriver

nodefq

nofnconv

useCOALESCE

needlongdatalen

bUnicodeStream

useCASTCHAR

noconcat

nvl

Feedback