Skip to main content

%SQL.StatementParameter

Class %SQL.StatementParameter Extends %SerialObject [ StorageStrategy = rsmdParameter, System = 2 ]

%SQL.StatementParameter - metadata for a statement parameter. A StatementParameter instance contains the definition of a statement parameter. A statement parameter is a specific type of statement column. That type is defined in the columnType property. SQLRESULTCOL columns are not modeled as StatementParameter instances. Rather, a SQLRESULTCOL column is a StatementColumn instance.

Properties​

ODBCType​

Property ODBCType As %Integer;

precision​

Property precision As %Integer;

scale​

Property scale As %Integer;

isNullable​

Property isNullable As %Boolean;

colName​

Property colName As %String(MAXLEN = 255);

columnType​

Property columnType As %Integer(MAXVAL = 5);

columnType is the ODBC column type: SQLPARAMTYPEUNKNOWN 0 SQLPARAMINPUT 1 SQLPARAMINPUTOUTPUT 2 SQLRESULTCOL 3 SQLPARAMOUTPUT 4 SQLRETURNVALUE 5 SQLRESULTCOL types are not StatementParameter instances. Rather, SQLRESULTCOL columns are StatementColumn objects.

Methods​

getColInfo​

Method getColInfo() As %Library.List [ Internal ]

getColInfo returns an output column descriptor from a parameter definition if the parameter has output direction (types 2,4, and 5)