This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %TSQL.sys.columns


persistent class %TSQL.sys.columns extends %Library.Persistent

SQL Table Name: %TSQL_sys.columns

Contains one row for every column in every table and view, and a row for each parameter in a stored procedure.

Property Inventory


parameter READONLY = 1;
Inherited description: READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.


property cdefault as %Integer;
ID of the default for this column. ID of the procedure that generates default value for this column
Property methods: cdefaultDisplayToLogical(), cdefaultGet(), cdefaultIsValid(), cdefaultLogicalToDisplay(), cdefaultNormalize(), cdefaultSet()
property colid as %SmallInt [ Required ];
Column or parameter ID.
Property methods: colidDisplayToLogical(), colidGet(), colidIsValid(), colidLogicalToDisplay(), colidNormalize(), colidSet()
property id as %Integer [ Required ];
Object ID of the table to which this column belongs, or the ID of the stored procedure with which this parameter is associated.
Property methods: idDisplayToLogical(), idGet(), idIsValid(), idLogicalToDisplay(), idNormalize(), idSet()
property length as %Integer;
Maximum physical storage length from systypes.
Property methods: lengthDisplayToLogical(), lengthGet(), lengthIsValid(), lengthLogicalToDisplay(), lengthNormalize(), lengthSet()
property name as %String (MAXLEN = 128);
Name of the column or procedure parameter.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property number as %SmallInt [ InitialExpression = 0 ];
Subprocedure number when the procedure is grouped (0 for nonprocedure entries).
Property methods: numberDisplayToLogical(), numberGet(), numberIsValid(), numberLogicalToDisplay(), numberNormalize(), numberSet()
property parentobjname as %String (MAXLEN = 128) [ SqlFieldName = parent_obj_name ];
Parent Object name Object name of the parent_obj.
Property methods: parentobjnameDisplayToLogical(), parentobjnameGet(), parentobjnameIsValid(), parentobjnameLogicalToDisplay(), parentobjnameLogicalToOdbc(), parentobjnameNormalize(), parentobjnameSet()
property prec as %SmallInt;
Level of precision for this column. Number of significant digits.
Property methods: precDisplayToLogical(), precGet(), precIsValid(), precLogicalToDisplay(), precNormalize(), precSet()
property scale as %Integer;
Scale for this column. Number of digits to the right of the decimal point
Property methods: scaleDisplayToLogical(), scaleGet(), scaleIsValid(), scaleLogicalToDisplay(), scaleNormalize(), scaleSet()
property schema as %String (MAXLEN = 128);
Name of the schema the column resides in
Property methods: schemaDisplayToLogical(), schemaGet(), schemaIsValid(), schemaLogicalToDisplay(), schemaLogicalToOdbc(), schemaNormalize(), schemaSet()
property status as %TinyInt;
Bitmap used to describe a property of the column or the parameter: Bits 0-2 (values 1, 2, and 4) indicate bit positioning if the column uses the bit datatype. If the column uses the text/image datatype, bits 0 and 1 indicate replication status as follows: 01 = always replicate 10 = replicate only if changed 00 = never replicate Bit 3 (value 8) indicates whether NULL values are legal in this column. Bit 4 (value 16) indicates whether more than one check constraint exists for the column. Bits 5 and 6 are used internally. Bit 7 (value 128) indicates an identity column. Bit 8 is unused.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusNormalize(), statusSet()
property usertype as %Library.String (MAXLEN = 50);
ID of user-defined data type from systypes.
Property methods: usertypeDisplayToLogical(), usertypeGet(), usertypeIsValid(), usertypeLogicalToDisplay(), usertypeLogicalToOdbc(), usertypeNormalize(), usertypeSet()


index (IDKEYIndex on id,colid) [IdKey, Type = key, Unique];
Index methods: IDKEYIndexCheck(), IDKEYIndexDelete(), IDKEYIndexExists(), IDKEYIndexOpen(), IDKEYIndexSQLCheckUnique(), IDKEYIndexSQLExists(), IDKEYIndexSQLFindPKeyByConstraint(), IDKEYIndexSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: CacheSQLStorage

Maps: 2

FeedbackOpens in a new window