This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%SQL.StatementParameter

serial class %SQL.StatementParameter extends %Library.SerialObject

%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.

Property Inventory

Properties

property ODBCType as %Integer;
Property methods: ODBCTypeDisplayToLogical(), ODBCTypeGet(), ODBCTypeIsValid(), ODBCTypeLogicalToDisplay(), ODBCTypeNormalize(), ODBCTypeSet()
property colName as %String (MAXLEN = 255);
Property methods: colNameDisplayToLogical(), colNameGet(), colNameIsValid(), colNameLogicalToDisplay(), colNameLogicalToOdbc(), colNameNormalize(), colNameSet()
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.
Property methods: columnTypeDisplayToLogical(), columnTypeGet(), columnTypeIsValid(), columnTypeLogicalToDisplay(), columnTypeNormalize(), columnTypeSet()
property isNullable as %Boolean;
Property methods: isNullableDisplayToLogical(), isNullableGet(), isNullableIsValid(), isNullableLogicalToDisplay(), isNullableNormalize(), isNullableSet()
property precision as %Integer;
Property methods: precisionDisplayToLogical(), precisionGet(), precisionIsValid(), precisionLogicalToDisplay(), precisionNormalize(), precisionSet()
property scale as %Integer;
Property methods: scaleDisplayToLogical(), scaleGet(), scaleIsValid(), scaleLogicalToDisplay(), scaleNormalize(), scaleSet()

Inherited Members

Inherited Methods

Feedback