persistent class INFORMATION.SCHEMA.COLUMNS
extends %Library.Persistent
SQL Table Name: COLUMNS
Returns one row for each column that can be accessed by the current user in the current namespace.
• parameter READONLY = 1;
READONLY = 1 means that objects can be created, opened but not saved or deleted.
Tables are projected to SQL as READONLY.
• 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 CHARACTERMAXIMUMLENGTH
as %Integer [ Calculated,SqlFieldName = CHARACTER_MAXIMUM_LENGTH ];
Column's maximum length, in characters, for binary or character data.
• 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 CHARACTERSETCATALOG
as %String(MAXLEN=3) [ Calculated,SqlFieldName = CHARACTER_SET_CATALOG ];
Reserved for future use. For InterSystems IRIS CHARACTER_SET_CATALOG is always NULL.
• 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 CHARACTERSETSCHEMA
as %String(MAXLEN=3) [ Calculated,SqlFieldName = CHARACTER_SET_SCHEMA ];
Reserved for future use. For InterSystems IRIS CHARACTER_SET_SCHEMA is always NULL.
• property COLLATIONCATALOG
as %String(MAXLEN=3) [ Calculated,SqlFieldName = COLLATION_CATALOG ];
Reserved for future use. For InterSystems IRIS COLLATION_CATALOG is always NULL.
• property COLLATIONNAME
as %String(MAXLEN=3) [ Calculated,SqlFieldName = COLLATION_NAME ];
Reserved for future use. For InterSystems IRIS COLLATION_NAME is always NULL.
• property COLLATIONSCHEMA
as %String(MAXLEN=3) [ Calculated,SqlFieldName = COLLATION_SCHEMA ];
Reserved for future use. For InterSystems IRIS COLLATION_SCHEMA is always NULL.
• property COLUMNDEFAULT
as %String(MAXLEN=4000) [ SqlFieldName = COLUMN_DEFAULT ];
Default value for the column.
• property COLUMNNAME
as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = COLUMN_NAME,Required ];
Name of the column.
• property DATATYPE
as %String(MAXLEN=128) [ SqlFieldName = DATA_TYPE ];
Name of the ODBC type for this column.
• property DATETIMEPRECISION
as %String(MAXLEN=3) [ Calculated,SqlFieldName = DATETIME_PRECISION ];
Reserved for future use. For InterSystems IRIS DATETIME_PRECISION is always NULL.
• property DESCRIPTION
as %String(MAXLEN=8192) [ Calculated,SqlFieldName = DESCRIPTION ];
Description of the column from the class definition. Returns NULL if the column is not from a table.
• property DOMAINCATALOG
as %String(MAXLEN=3) [ Calculated,SqlFieldName = DOMAIN_CATALOG ];
Reserved for future use. For InterSystems IRIS DOMAIN_CATALOG is always NULL.
• property DOMAINNAME
as %String(MAXLEN=3) [ Calculated,SqlFieldName = DOMAIN_NAME ];
Reserved for future use. For InterSystems IRIS DOMAIN_NAME is always NULL.
• property DOMAINSCHEMA
as %String(MAXLEN=3) [ Calculated,SqlFieldName = DOMAIN_SCHEMA ];
Reserved for future use. For InterSystems IRIS DOMAIN_SCHEMA is always NULL.
• property DTDIDENTIFIER
as %String(MAXLEN=3) [ Calculated,SqlFieldName = DTD_IDENTIFIER ];
Reserved for future use. For InterSystems IRIS DTD_IDENTIFIER is always NULL.
• property GENERATIONEXPRESSION
as %String(MAXLEN=3) [ Calculated,SqlFieldName = GENERATION_EXPRESSION ];
Reserved for future use. For InterSystems IRIS GENERATION_EXPRESSION is always NULL.
• property IDENTITYCYCLE
as %String(MAXLEN=3) [ Calculated,SqlFieldName = IDENTITY_CYCLE ];
Reserved for future use. For InterSystems IRIS IDENTITY_CYCLE is always NULL.
• 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 IDENTITYINCREMENT
as %String(MAXLEN=3) [ Calculated,SqlFieldName = IDENTITY_INCREMENT ];
Reserved for future use. For InterSystems IRIS IDENTITY_INCREMENT is always NULL.
• property IDENTITYMAXIMUM
as %String(MAXLEN=3) [ Calculated,SqlFieldName = IDENTITY_MAXIMUM ];
Reserved for future use. For InterSystems IRIS IDENTITY_MAXIMUM is always NULL.
• property IDENTITYMINIMUM
as %String(MAXLEN=3) [ Calculated,SqlFieldName = IDENTITY_MINIMUM ];
Reserved for future use. For InterSystems IRIS IDENTITY_MINIMUM is always NULL.
• property IDENTITYSTART
as %String(MAXLEN=3) [ Calculated,SqlFieldName = IDENTITY_START ];
Reserved for future use. For InterSystems IRIS IDENTITY_START is always NULL.
• property ISGENERATED
as %String(MAXLEN=3) [ SqlFieldName = IS_GENERATED ];
If the column is an SqlComputed column IS_GENERATED returns YES, otherwise NO.
• 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 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 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 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 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 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 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 ORDINALPOSITION
as %Integer [ SqlFieldName = ORDINAL_POSITION,Required ];
Column's ordinal position within the table.
• 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 TABLECATALOG
as %String(MAXLEN=128) [ Calculated,SqlFieldName = TABLE_CATALOG ];
Table qualifier - always NULL in InterSystems IRIS
• property TABLENAME
as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = TABLE_NAME,Required ];
Name of the table.
• property TABLESCHEMA
as %String(COLLATION="Upper",MAXLEN=128) [ SqlFieldName = TABLE_SCHEMA,Required ];
Name of schema that contains the table.
• 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.
