INFORMATION.SCHEMA.COLUMNS

persistent class INFORMATION.SCHEMA.COLUMNS extends %Library.Persistent [ Final ]

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

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

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 InterSystems IRIS 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 InterSystems IRIS 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 InterSystems IRIS 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 InterSystems IRIS 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 InterSystems IRIS 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 InterSystems IRIS 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 InterSystems IRIS 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 InterSystems IRIS DATETIME_PRECISION is always NULL.

Property methods: DATETIMEPRECISIONCompute(), DATETIMEPRECISIONDisplayToLogical(), DATETIMEPRECISIONGet(), DATETIMEPRECISIONIsValid(), DATETIMEPRECISIONLogicalToDisplay(), DATETIMEPRECISIONLogicalToOdbc(), DATETIMEPRECISIONNormalize(), DATETIMEPRECISIONSQLCompute()

property DESCRIPTION as %String (MAXLEN = 8192) [ 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 InterSystems IRIS 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 InterSystems IRIS 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 ];

Reserved for future use. For InterSystems IRIS DOMAIN_SCHEMA is always NULL.

Property methods: DOMAINSCHEMACompute(), DOMAINSCHEMADisplayToLogical(), DOMAINSCHEMAGet(), DOMAINSCHEMAIsValid(), DOMAINSCHEMALogicalToDisplay(), DOMAINSCHEMALogicalToOdbc(), DOMAINSCHEMANormalize(), DOMAINSCHEMASQLCompute()

property DTDIDENTIFIER as %String (MAXLEN = 3) [ Calculated , SqlFieldName = DTD_IDENTIFIER ];

Reserved for future use. For InterSystems IRIS DTD_IDENTIFIER is always NULL.

Property methods: DTDIDENTIFIERCompute(), DTDIDENTIFIERDisplayToLogical(), DTDIDENTIFIERGet(), DTDIDENTIFIERIsValid(), DTDIDENTIFIERLogicalToDisplay(), DTDIDENTIFIERLogicalToOdbc(), DTDIDENTIFIERNormalize(), DTDIDENTIFIERSQLCompute()

property GENERATIONEXPRESSION as %String (MAXLEN = 3) [ Calculated , SqlFieldName = GENERATION_EXPRESSION ];

Reserved for future use. For InterSystems IRIS GENERATION_EXPRESSION is always NULL.

Property methods: GENERATIONEXPRESSIONCompute(), GENERATIONEXPRESSIONDisplayToLogical(), GENERATIONEXPRESSIONGet(), GENERATIONEXPRESSIONIsValid(), GENERATIONEXPRESSIONLogicalToDisplay(), GENERATIONEXPRESSIONLogicalToOdbc(), GENERATIONEXPRESSIONNormalize(), GENERATIONEXPRESSIONSQLCompute()

property IDENTITYCYCLE as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IDENTITY_CYCLE ];

Reserved for future use. For InterSystems IRIS IDENTITY_CYCLE is always NULL.

Property methods: IDENTITYCYCLECompute(), IDENTITYCYCLEDisplayToLogical(), IDENTITYCYCLEGet(), IDENTITYCYCLEIsValid(), IDENTITYCYCLELogicalToDisplay(), IDENTITYCYCLELogicalToOdbc(), IDENTITYCYCLENormalize(), IDENTITYCYCLESQLCompute()

property IDENTITYGENERATION as %String (MAXLEN = 10, VALUELIST = ",ALWAYS,BY DEFAULT") [ Calculated , SqlFieldName = IDENTITY_GENERATION ];

Reserved for future use. For InterSystems IRIS IDENTITY_GENERATION is always NULL.

Property methods: IDENTITYGENERATIONCompute(), IDENTITYGENERATIONDisplayToLogical(), IDENTITYGENERATIONGet(), IDENTITYGENERATIONIsValid(), IDENTITYGENERATIONLogicalToDisplay(), IDENTITYGENERATIONLogicalToOdbc(), IDENTITYGENERATIONNormalize(), IDENTITYGENERATIONSQLCompute()

property IDENTITYINCREMENT as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IDENTITY_INCREMENT ];

Reserved for future use. For InterSystems IRIS IDENTITY_INCREMENT is always NULL.

Property methods: IDENTITYINCREMENTCompute(), IDENTITYINCREMENTDisplayToLogical(), IDENTITYINCREMENTGet(), IDENTITYINCREMENTIsValid(), IDENTITYINCREMENTLogicalToDisplay(), IDENTITYINCREMENTLogicalToOdbc(), IDENTITYINCREMENTNormalize(), IDENTITYINCREMENTSQLCompute()

property IDENTITYMAXIMUM as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IDENTITY_MAXIMUM ];

Reserved for future use. For InterSystems IRIS IDENTITY_MAXIMUM is always NULL.

Property methods: IDENTITYMAXIMUMCompute(), IDENTITYMAXIMUMDisplayToLogical(), IDENTITYMAXIMUMGet(), IDENTITYMAXIMUMIsValid(), IDENTITYMAXIMUMLogicalToDisplay(), IDENTITYMAXIMUMLogicalToOdbc(), IDENTITYMAXIMUMNormalize(), IDENTITYMAXIMUMSQLCompute()

property IDENTITYMINIMUM as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IDENTITY_MINIMUM ];

Reserved for future use. For InterSystems IRIS IDENTITY_MINIMUM is always NULL.

Property methods: IDENTITYMINIMUMCompute(), IDENTITYMINIMUMDisplayToLogical(), IDENTITYMINIMUMGet(), IDENTITYMINIMUMIsValid(), IDENTITYMINIMUMLogicalToDisplay(), IDENTITYMINIMUMLogicalToOdbc(), IDENTITYMINIMUMNormalize(), IDENTITYMINIMUMSQLCompute()

property IDENTITYSTART as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IDENTITY_START ];

Reserved for future use. For InterSystems IRIS IDENTITY_START is always NULL.

Property methods: IDENTITYSTARTCompute(), IDENTITYSTARTDisplayToLogical(), IDENTITYSTARTGet(), IDENTITYSTARTIsValid(), IDENTITYSTARTLogicalToDisplay(), IDENTITYSTARTLogicalToOdbc(), IDENTITYSTARTNormalize(), IDENTITYSTARTSQLCompute()

property ISGENERATED as %String (MAXLEN = 3) [ SqlFieldName = IS_GENERATED ];

If the column is an SqlComputed column IS_GENERATED returns YES, otherwise NO.

Property methods: ISGENERATEDDisplayToLogical(), ISGENERATEDGet(), ISGENERATEDIsValid(), ISGENERATEDLogicalToDisplay(), ISGENERATEDLogicalToOdbc(), ISGENERATEDNormalize(), ISGENERATEDSet()

property ISIDENTITY as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ SqlFieldName = IS_IDENTITY ];

If this column is an IDENTITY column IS_IDENTITY returns YES, otherwise NO.

Property methods: ISIDENTITYDisplayToLogical(), ISIDENTITYGet(), ISIDENTITYIsValid(), ISIDENTITYLogicalToDisplay(), ISIDENTITYLogicalToOdbc(), ISIDENTITYNormalize(), ISIDENTITYSet()

property ISNULLABLE as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ SqlFieldName = IS_NULLABLE ];

If the column allows a NULL value, IS_NULLABLE returns YES, otherwise NO.

Property methods: ISNULLABLEDisplayToLogical(), ISNULLABLEGet(), ISNULLABLEIsValid(), ISNULLABLELogicalToDisplay(), ISNULLABLELogicalToOdbc(), ISNULLABLENormalize(), ISNULLABLESet()

property ISSELFREFERENCING as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ Calculated , SqlFieldName = IS_SELF_REFERENCING ];

Reserved for future use. For InterSystems IRIS IS_SELF_REFERENCING is always NULL.

Property methods: ISSELFREFERENCINGCompute(), ISSELFREFERENCINGDisplayToLogical(), ISSELFREFERENCINGGet(), ISSELFREFERENCINGIsValid(), ISSELFREFERENCINGLogicalToDisplay(), ISSELFREFERENCINGLogicalToOdbc(), ISSELFREFERENCINGNormalize(), ISSELFREFERENCINGSQLCompute()

property ISUPDATABLE as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IS_UPDATABLE ];

Returns YES if the column is updatable, otherwise NO.
All base tables are updatable and every column of a base table is updatable.
A view colum's updatability depends on the view's updatablity.

Property methods: ISUPDATABLECompute(), ISUPDATABLEDisplayToLogical(), ISUPDATABLEGet(), ISUPDATABLEIsValid(), ISUPDATABLELogicalToDisplay(), ISUPDATABLELogicalToOdbc(), ISUPDATABLENormalize(), ISUPDATABLESQLCompute()

property NUMERICPRECISION as %Library.TinyInt [ Calculated , SqlFieldName = NUMERIC_PRECISION ];

Column's precision for fields of datatype TINYINT, SMALLINT, INTEGER, BIGINT, NUMERIC, and DOUBLE. Otherwise, NULL is returned.

Property methods: NUMERICPRECISIONCompute(), NUMERICPRECISIONDisplayToLogical(), NUMERICPRECISIONGet(), NUMERICPRECISIONIsValid(), NUMERICPRECISIONLogicalToDisplay(), NUMERICPRECISIONNormalize(), NUMERICPRECISIONSQLCompute()

property NUMERICPRECISIONRADIX as %Library.SmallInt [ Calculated , SqlFieldName = NUMERIC_PRECISION_RADIX ];

Column's precision radix for fields of datatype TINYINT, SMALLINT, INTEGER, BIGINT, NUMERIC, and DOUBLE. Otherwise, NULL is returned.

Property methods: NUMERICPRECISIONRADIXCompute(), NUMERICPRECISIONRADIXDisplayToLogical(), NUMERICPRECISIONRADIXGet(), NUMERICPRECISIONRADIXIsValid(), NUMERICPRECISIONRADIXLogicalToDisplay(), NUMERICPRECISIONRADIXNormalize(), NUMERICPRECISIONRADIXSQLCompute()

property NUMERICSCALE as %Integer [ Calculated , SqlFieldName = NUMERIC_SCALE ];

Column's numeric scale for fields of datatype TINYINT, SMALLINT, INTEGER, BIGINT, NUMERIC, and DOUBLE. Otherwise, NULL is returned.

Property methods: NUMERICSCALECompute(), NUMERICSCALEDisplayToLogical(), NUMERICSCALEGet(), NUMERICSCALEIsValid(), NUMERICSCALELogicalToDisplay(), NUMERICSCALENormalize(), NUMERICSCALESQLCompute()

property ORDINALPOSITION as %Integer [ SqlFieldName = ORDINAL_POSITION , Required ];

Column's ordinal position within the table.

Property methods: ORDINALPOSITIONDisplayToLogical(), ORDINALPOSITIONGet(), ORDINALPOSITIONIsValid(), ORDINALPOSITIONLogicalToDisplay(), ORDINALPOSITIONNormalize(), ORDINALPOSITIONSet()

property PRIMARYKEY as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ SqlFieldName = PRIMARY_KEY ];

If this column appears in the primary key constraint for this table, PRIMARY_KEY returns YES, otherwise NO.

Property methods: PRIMARYKEYDisplayToLogical(), PRIMARYKEYGet(), PRIMARYKEYIsValid(), PRIMARYKEYLogicalToDisplay(), PRIMARYKEYLogicalToOdbc(), PRIMARYKEYNormalize(), PRIMARYKEYSet()

property TABLECATALOG as %String (MAXLEN = 128) [ Calculated , SqlFieldName = TABLE_CATALOG ];

Table qualifier - always NULL in InterSystems IRIS

Property methods: TABLECATALOGCompute(), TABLECATALOGDisplayToLogical(), TABLECATALOGGet(), TABLECATALOGIsValid(), TABLECATALOGLogicalToDisplay(), TABLECATALOGLogicalToOdbc(), TABLECATALOGNormalize(), TABLECATALOGSQLCompute()

property TABLENAME as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = TABLE_NAME , Required ];

Name of the table.

Property methods: TABLENAMEDisplayToLogical(), TABLENAMEGet(), TABLENAMEIsValid(), TABLENAMELogicalToDisplay(), TABLENAMELogicalToOdbc(), TABLENAMENormalize(), TABLENAMESet()

property TABLESCHEMA as %String (COLLATION = "Upper", MAXLEN = 128) [ SqlFieldName = TABLE_SCHEMA , Required ];

Name of schema that contains the table.

Property methods: TABLESCHEMADisplayToLogical(), TABLESCHEMAGet(), TABLESCHEMAIsValid(), TABLESCHEMALogicalToDisplay(), TABLESCHEMALogicalToOdbc(), TABLESCHEMANormalize(), TABLESCHEMASet()

property UNIQUECOLUMN as %String (MAXLEN = 3, VALUELIST = ",YES,NO") [ SqlFieldName = UNIQUE_COLUMN ];

If this column in the sole column in a unique constraint, UNIQUE_COLUMN returns YES, otherwise NO.

Property methods: UNIQUECOLUMNDisplayToLogical(), UNIQUECOLUMNGet(), UNIQUECOLUMNIsValid(), UNIQUECOLUMNLogicalToDisplay(), UNIQUECOLUMNLogicalToOdbc(), UNIQUECOLUMNNormalize(), UNIQUECOLUMNSet()

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: SQLStorage

Maps: 1

Map number 1 is named Master

thismap.Global: ^oddSQL

^oddSQL({SchemaExact},{TableExact},8,{ORDINAL_POSITION})

Node	Delimiter	Piece	Name
			DATA_TYPE
		2	TABLE_SCHEMA
		3	TABLE_NAME
		4	COLUMN_NAME
		5	odbctype
		13	COLUMN_DEFAULT
		18	IS_NULLABLE
		23	AUTO_INCREMENT
		24	IS_GENERATED
		25	IS_IDENTITY
		26	UNIQUE_COLUMN
		27	PRIMARY_KEY