Class %SQL.StatementColumn

serial class %SQL.StatementColumn extends %SerialObject

%SQL.StatementColumn - contains the metadata for a statement column whose column type is SQLRESULTCOL.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	25	5

Summary

Properties
ODBCType	clientType	colName	isAliased
isAutoIncrement	isCaseSensitive	isCurrency	isExpression
isHidden	isIdentity	isKeyColumn	isList
isNullable	isReadOnly	isRowId	isRowVersion
isUnique	label	precision	property
qualifier	scale	schemaName	tableName
typeClass

Methods
%AddToSaveSet	%AddToSyncSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%Delete	%DeleteId	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends	%GetParameter
%GetSwizzleObject	%IsA	%IsModified	%IsNull
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%OnBeforeAddToSync	%OnDetermineClass	%Open	%OpenId
%OriginalNamespace	%PackageName	%RemoveFromSaveSet	%ResolveConcurrencyConflict
%SerializeObject	%SetModified	%SyncObjectIn	%SyncTransport
%ToDynamicObject	%ToJSONValue	%ValidateObject	IsNumeric
LogicalToOdbc	OdbcToLogical

Properties

• property ODBCType as %Integer;

The column ODBC type integer:

• property clientType as %Integer;

Returns the type of column n in the result set where type is an integer associated with the client datatype. If the type cannot be determined, 0 (zero) is returned.

1 BINARY

2 DATE

3 DOUBLE

4 HANDLE

5 INTEGER

6 LIST

7 LONGVARCHAR

8 TIME

9 TIMESTAMP

10 VARCHAR

11 STATUS

12 BINARYSTREAM

13 CHARACTERSTREAM

14 NUMERIC

15 CURRENCY

16 BOOLEAN

17 OID

18 BIGINT

19 FDATE

20 FTIMESTAMP

• property colName as %String(MAXLEN=255);

The column name.

• property isAliased as %Boolean;

• property isAutoIncrement as %Boolean;

• property isCaseSensitive as %Boolean;

• property isCurrency as %Boolean;

• property isExpression as %Boolean;

• property isHidden as %Boolean;

• property isIdentity as %Boolean;

• property isKeyColumn as %Boolean;

• property isList as %Boolean;

• property isNullable as %Boolean;

isNullable is TRUE (1) if the column value can be NULL.

• property isReadOnly as %Boolean;

• property isRowId as %Boolean;

• property isRowVersion as %Boolean;

• property isUnique as %Boolean;

• property label as %String(MAXLEN=255);

• property precision as %Integer;

Precision

• property property as %Dictionary.CompiledProperty;

If this column corresponds to a property from the class that projected the tableName table. This property is NULL if the column cannot be linked to a property.

• property qualifier as %String;

• property scale as %Integer;

Scale

• property schemaName as %String;

The schema qualifier of tableName.

• property tableName as %String;

The table where this column originates.

• property typeClass as %Dictionary.CompiledClass;

The objects type class

Methods

• method %ToDynamicObject(target As %DynamicObject = "", ignoreUnknown=0) as %Library.DynamicObject

Default mechanism for mapping the fields of a registered object to the key-value pairs of a dynamic entity. This method exists only to provide the user with the ability to override the default composition of a dynamic object from a registered object.

• method %ToJSONValue(Output outstr="") as %String

Default behavior of the JSON generation facility. Map the current registered object into a dynamic one via $toAbstractObject() and output the JSON representation of the abstract object. Subclasses may wish to override this routine to perform post processing on the abstract object prior to JSON generation, or dispense with the abstract layer entirely in favor of direct, local JSON output

• method IsNumeric() as %Boolean

1		BINARY
2		DATE
3		DOUBLE
4		HANDLE
5		INTEGER
6		LIST
7		LONGVARCHAR
8		TIME
9		TIMESTAMP
10		VARCHAR
11		STATUS
12		BINARYSTREAM
13		CHARACTERSTREAM
14		NUMERIC
15		CURRENCY
16		BOOLEAN
17		OID
18		BIGINT
19		FDATE
20		FTIMESTAMP

Class Reference IRIS for UNIX 2024.1.2
Documentation Search