Home > Class Reference > ENSLIB namespace > INFORMATION.SCHEMA.COLUMNS

INFORMATION.SCHEMA.COLUMNS

persistent class INFORMATION.SCHEMA.COLUMNS extends %Library.Persistent

SQL Table Name: INFORMATION_SCHEMA.COLUMNS

Returns one row for each column that can be accessed by the current user in the current namespace.

Property Inventory (Including Private)

Parameters

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.

Properties (Including Private)

property AUTOINCREMENT as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ SqlFieldName = AUTO_INCREMENT ];
If this column increments automatically upon insert, AUTO_INCREMENT returns YES, otherwise NO.
Property methods: AUTOINCREMENTDisplayToLogical(), AUTOINCREMENTGet(), AUTOINCREMENTIsValid(), AUTOINCREMENTLogicalToDisplay(), AUTOINCREMENTLogicalToOdbc(), AUTOINCREMENTNormalize(), AUTOINCREMENTSet()
property CHARACTERMAXIMUMLENGTH as %Integer [ Calculated , SqlFieldName = CHARACTER_MAXIMUM_LENGTH ];
Column's maximum length, in characters, for binary or character data.
Property methods: CHARACTERMAXIMUMLENGTHCompute(), CHARACTERMAXIMUMLENGTHDisplayToLogical(), CHARACTERMAXIMUMLENGTHGet(), CHARACTERMAXIMUMLENGTHIsValid(), CHARACTERMAXIMUMLENGTHLogicalToDisplay(), CHARACTERMAXIMUMLENGTHNormalize(), CHARACTERMAXIMUMLENGTHSQLCompute()
property CHARACTEROCTETLENGTH as %Integer [ Calculated , SqlFieldName = CHARACTER_OCTET_LENGTH ];
Column's maximum length, in bytes, for binary or character data. For Caché this is the same as CHARACTER_MAXIMUM_LENGTH.
Property methods: CHARACTEROCTETLENGTHCompute(), CHARACTEROCTETLENGTHDisplayToLogical(), CHARACTEROCTETLENGTHGet(), CHARACTEROCTETLENGTHIsValid(), CHARACTEROCTETLENGTHLogicalToDisplay(), CHARACTEROCTETLENGTHNormalize(), CHARACTEROCTETLENGTHSQLCompute()
property CHARACTERSETCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = CHARACTER_SET_CATALOG ];
Reserved for future use. For Caché CHARACTER_SET_CATALOG is always NULL.
Property methods: CHARACTERSETCATALOGCompute(), CHARACTERSETCATALOGDisplayToLogical(), CHARACTERSETCATALOGGet(), CHARACTERSETCATALOGIsValid(), CHARACTERSETCATALOGLogicalToDisplay(), CHARACTERSETCATALOGLogicalToOdbc(), CHARACTERSETCATALOGNormalize(), CHARACTERSETCATALOGSQLCompute()
property CHARACTERSETNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = CHARACTER_SET_NAME ];
Reserved for future use. For Caché CHARACTER_SET_NAME is always NULL.
Property methods: CHARACTERSETNAMECompute(), CHARACTERSETNAMEDisplayToLogical(), CHARACTERSETNAMEGet(), CHARACTERSETNAMEIsValid(), CHARACTERSETNAMELogicalToDisplay(), CHARACTERSETNAMELogicalToOdbc(), CHARACTERSETNAMENormalize(), CHARACTERSETNAMESQLCompute()
property CHARACTERSETSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = CHARACTER_SET_SCHEMA ];
Reserved for future use. For Caché CHARACTER_SET_SCHEMA is always NULL.
Property methods: CHARACTERSETSCHEMACompute(), CHARACTERSETSCHEMADisplayToLogical(), CHARACTERSETSCHEMAGet(), CHARACTERSETSCHEMAIsValid(), CHARACTERSETSCHEMALogicalToDisplay(), CHARACTERSETSCHEMALogicalToOdbc(), CHARACTERSETSCHEMANormalize(), CHARACTERSETSCHEMASQLCompute()
property COLLATIONCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = COLLATION_CATALOG ];
Reserved for future use. For Caché COLLATION_CATALOG is always NULL.
Property methods: COLLATIONCATALOGCompute(), COLLATIONCATALOGDisplayToLogical(), COLLATIONCATALOGGet(), COLLATIONCATALOGIsValid(), COLLATIONCATALOGLogicalToDisplay(), COLLATIONCATALOGLogicalToOdbc(), COLLATIONCATALOGNormalize(), COLLATIONCATALOGSQLCompute()
property COLLATIONNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = COLLATION_NAME ];
Reserved for future use. For Caché COLLATION_NAME is always NULL.
Property methods: COLLATIONNAMECompute(), COLLATIONNAMEDisplayToLogical(), COLLATIONNAMEGet(), COLLATIONNAMEIsValid(), COLLATIONNAMELogicalToDisplay(), COLLATIONNAMELogicalToOdbc(), COLLATIONNAMENormalize(), COLLATIONNAMESQLCompute()
property COLLATIONSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = COLLATION_SCHEMA ];
Reserved for future use. For Caché COLLATION_SCHEMA is always NULL.
Property methods: COLLATIONSCHEMACompute(), COLLATIONSCHEMADisplayToLogical(), COLLATIONSCHEMAGet(), COLLATIONSCHEMAIsValid(), COLLATIONSCHEMALogicalToDisplay(), COLLATIONSCHEMALogicalToOdbc(), COLLATIONSCHEMANormalize(), COLLATIONSCHEMASQLCompute()
property COLUMNDEFAULT as %String (MAXLEN = 4000) [ SqlFieldName = COLUMN_DEFAULT ];
Default value for the column.
Property methods: COLUMNDEFAULTDisplayToLogical(), COLUMNDEFAULTGet(), COLUMNDEFAULTIsValid(), COLUMNDEFAULTLogicalToDisplay(), COLUMNDEFAULTLogicalToOdbc(), COLUMNDEFAULTNormalize(), COLUMNDEFAULTSet()
property COLUMNNAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = COLUMN_NAME , Required ];
Name of the column.
Property methods: COLUMNNAMEDisplayToLogical(), COLUMNNAMEGet(), COLUMNNAMEIsValid(), COLUMNNAMELogicalToDisplay(), COLUMNNAMELogicalToOdbc(), COLUMNNAMENormalize(), COLUMNNAMESet()
property DATATYPE as %String (MAXLEN = 128) [ SqlFieldName = DATA_TYPE ];
Name of the ODBC type for this column.
Property methods: DATATYPEDisplayToLogical(), DATATYPEGet(), DATATYPEIsValid(), DATATYPELogicalToDisplay(), DATATYPELogicalToOdbc(), DATATYPENormalize(), DATATYPESet()
property DATETIMEPRECISION as %String (MAXLEN = 3) [ Calculated , SqlFieldName = DATETIME_PRECISION ];
Reserved for future use. For Caché DATETIME_PRECISION is always NULL.
Property methods: DATETIMEPRECISIONCompute(), DATETIMEPRECISIONDisplayToLogical(), DATETIMEPRECISIONGet(), DATETIMEPRECISIONIsValid(), DATETIMEPRECISIONLogicalToDisplay(), DATETIMEPRECISIONLogicalToOdbc(), DATETIMEPRECISIONNormalize(), DATETIMEPRECISIONSQLCompute()
property DESCRIPTION as %String (MAXLEN = 3) [ Calculated ];
Description of the column from the class definition. Returns NULL if the column is not from a table.
Property methods: DESCRIPTIONCompute(), DESCRIPTIONDisplayToLogical(), DESCRIPTIONGet(), DESCRIPTIONIsValid(), DESCRIPTIONLogicalToDisplay(), DESCRIPTIONLogicalToOdbc(), DESCRIPTIONNormalize(), DESCRIPTIONSQLCompute()
property DOMAINCATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = DOMAIN_CATALOG ];
Reserved for future use. For Caché DOMAIN_CATALOG is always NULL.
Property methods: DOMAINCATALOGCompute(), DOMAINCATALOGDisplayToLogical(), DOMAINCATALOGGet(), DOMAINCATALOGIsValid(), DOMAINCATALOGLogicalToDisplay(), DOMAINCATALOGLogicalToOdbc(), DOMAINCATALOGNormalize(), DOMAINCATALOGSQLCompute()
property DOMAINNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = DOMAIN_NAME ];
Reserved for future use. For Caché DOMAIN_NAME is always NULL.
Property methods: DOMAINNAMECompute(), DOMAINNAMEDisplayToLogical(), DOMAINNAMEGet(), DOMAINNAMEIsValid(), DOMAINNAMELogicalToDisplay(), DOMAINNAMELogicalToOdbc(), DOMAINNAMENormalize(), DOMAINNAMESQLCompute()
property DOMAINSCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = DOMAIN_SCHEMA ];