COLUMNS Class Reference

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

Inheritance diagram for COLUMNS:

Collaboration diagram for COLUMNS:

Public Attributes
	AUTOINCREMENT
	If this column increments automatically upon insert, AUTO_INCREMENT returns YES, otherwise NO. More...
	CHARACTERMAXIMUMLENGTH
	Column's maximum length, in characters, for binary or character data. More...
	CHARACTEROCTETLENGTH
	Column's maximum length, in bytes, for binary or character data. More...
	CHARACTERSETCATALOG
	Reserved for future use. More...
	CHARACTERSETNAME
	Reserved for future use. More...
	CHARACTERSETSCHEMA
	Reserved for future use. More...
	COLLATIONCATALOG
	Reserved for future use. More...
	COLLATIONNAME
	Reserved for future use. More...
	COLLATIONSCHEMA
	Reserved for future use. More...
	COLUMNDEFAULT
	Default value for the column. More...
	COLUMNNAME
	Name of the column. More...
	DATATYPE
	Name of the ODBC type for this column. More...
	DATETIMEPRECISION
	Reserved for future use. More...
	DESCRIPTION
	Description of the column from the class definition. More...
	DOMAINCATALOG
	Reserved for future use. More...
	DOMAINNAME
	Reserved for future use. More...
	DOMAINSCHEMA
	Reserved for future use. More...
	DTDIDENTIFIER
	Reserved for future use. More...
	GENERATIONEXPRESSION
	Reserved for future use. More...
	IDENTITYCYCLE
	Reserved for future use. More...
	IDENTITYGENERATION
	Reserved for future use. More...
	IDENTITYINCREMENT
	Reserved for future use. More...
	IDENTITYMAXIMUM
	Reserved for future use. More...
	IDENTITYMINIMUM
	Reserved for future use. More...
	IDENTITYSTART
	Reserved for future use. More...
	ISGENERATED
	If the column is an SqlComputed column IS_GENERATED returns YES, otherwise NO. More...
	ISIDENTITY
	If this column is an IDENTITY column IS_IDENTITY returns YES, otherwise NO. More...
	ISNULLABLE
	If the column allows a NULL value, IS_NULLABLE returns YES, otherwise NO. More...
	ISSELFREFERENCING
	Reserved for future use. More...
	ISUPDATABLE
	Returns YES if the column is updatable, otherwise NO. More...
	NUMERICPRECISION
	Column's precision for fields of datatype TINYINT, SMALLINT, INTEGER, BIGINT, NUMERIC, and DOUBLE. More...
	NUMERICPRECISIONRADIX
	Column's precision radix for fields of datatype TINYINT, SMALLINT, INTEGER, BIGINT, NUMERIC, and DOUBLE. More...
	NUMERICSCALE
	Column's numeric scale for fields of datatype TINYINT, SMALLINT, INTEGER, BIGINT, NUMERIC, and DOUBLE. More...
	ORDINALPOSITION
	Column's ordinal position within the table. More...
	PRIMARYKEY
	If this column appears in the primary key constraint for this table, PRIMARY_KEY returns YES, otherwise NO. More...
	TABLECATALOG
	Table qualifier - always NULL in InterSystems IRIS. More...
	TABLENAME
	Name of the table. More...
	TABLESCHEMA
	Name of schema that contains the table. More...
	UNIQUECOLUMN
	If this column in the sole column in a unique constraint, UNIQUE_COLUMN returns YES, otherwise NO. More...

Private Attributes
	__COMPUTECODE
	The SqlComputeCode for this column. More...
	__ISPERSISTED
	This field expresses whether the column's value is actually persisted, meaning nor calculated nor transient. More...
	__PROPERTYNAME
	The class property name projected to this column. More...

Additional Inherited Members
Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...
_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...
_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...
_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...
Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...
_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...
_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)
_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)
_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...
	DEFAULTGLOBAL = None
	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...
	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
	USEEXTENTSET = None
	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

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

Member Data Documentation

AUTOINCREMENT

AUTOINCREMENT

If this column increments automatically upon insert, AUTO_INCREMENT returns YES, otherwise NO.

 

CHARACTERMAXIMUMLENGTH

CHARACTERMAXIMUMLENGTH

Column's maximum length, in characters, for binary or character data.

 

CHARACTEROCTETLENGTH

CHARACTEROCTETLENGTH

Column's maximum length, in bytes, for binary or character data.

For InterSystems IRIS this is the same as CHARACTER_MAXIMUM_LENGTH.

 

CHARACTERSETCATALOG

CHARACTERSETCATALOG

Reserved for future use.

For InterSystems IRIS CHARACTER_SET_CATALOG is always NULL.

 

CHARACTERSETNAME

CHARACTERSETNAME

Reserved for future use.

For InterSystems IRIS CHARACTER_SET_NAME is always NULL.

 

CHARACTERSETSCHEMA

CHARACTERSETSCHEMA

Reserved for future use.

For InterSystems IRIS CHARACTER_SET_SCHEMA is always NULL.

 

COLLATIONCATALOG

COLLATIONCATALOG

Reserved for future use.

For InterSystems IRIS COLLATION_CATALOG is always NULL.

 

COLLATIONNAME

COLLATIONNAME

Reserved for future use.

For InterSystems IRIS COLLATION_NAME is always NULL.

 

COLLATIONSCHEMA

COLLATIONSCHEMA

Reserved for future use.

For InterSystems IRIS COLLATION_SCHEMA is always NULL.

 

COLUMNDEFAULT

COLUMNDEFAULT

Default value for the column.

 

COLUMNNAME

COLUMNNAME

Name of the column.

 

__COMPUTECODE

__COMPUTECODE

private

The SqlComputeCode for this column.

 

DATATYPE

DATATYPE

Name of the ODBC type for this column.

 

DATETIMEPRECISION

DATETIMEPRECISION

Reserved for future use.

For InterSystems IRIS DATETIME_PRECISION is always NULL.

 

DESCRIPTION

DESCRIPTION

Description of the column from the class definition.

Returns NULL if the column is not from a table.

 

DOMAINCATALOG

DOMAINCATALOG

Reserved for future use.

For InterSystems IRIS DOMAIN_CATALOG is always NULL.

 

DOMAINNAME

DOMAINNAME

Reserved for future use.

For InterSystems IRIS DOMAIN_NAME is always NULL.

 

DOMAINSCHEMA

DOMAINSCHEMA

Reserved for future use.

For InterSystems IRIS DOMAIN_SCHEMA is always NULL.

 

DTDIDENTIFIER

DTDIDENTIFIER

Reserved for future use.

For InterSystems IRIS DTD_IDENTIFIER is always NULL.

 

GENERATIONEXPRESSION

GENERATIONEXPRESSION

Reserved for future use.

For InterSystems IRIS GENERATION_EXPRESSION is always NULL.

 

IDENTITYCYCLE

IDENTITYCYCLE

Reserved for future use.

For InterSystems IRIS IDENTITY_CYCLE is always NULL.

 

IDENTITYGENERATION

IDENTITYGENERATION

Reserved for future use.

For InterSystems IRIS IDENTITY_GENERATION is always NULL.

 

IDENTITYINCREMENT

IDENTITYINCREMENT

Reserved for future use.

For InterSystems IRIS IDENTITY_INCREMENT is always NULL.

 

IDENTITYMAXIMUM

IDENTITYMAXIMUM

Reserved for future use.

For InterSystems IRIS IDENTITY_MAXIMUM is always NULL.

 

IDENTITYMINIMUM

IDENTITYMINIMUM

Reserved for future use.

For InterSystems IRIS IDENTITY_MINIMUM is always NULL.

 

IDENTITYSTART

IDENTITYSTART

Reserved for future use.

For InterSystems IRIS IDENTITY_START is always NULL.

 

ISGENERATED

ISGENERATED

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

 

ISIDENTITY

ISIDENTITY

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

 

ISNULLABLE

ISNULLABLE

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

 

__ISPERSISTED

__ISPERSISTED

private

This field expresses whether the column's value is actually persisted, meaning nor calculated nor transient.

 

ISSELFREFERENCING

ISSELFREFERENCING

Reserved for future use.

For InterSystems IRIS IS_SELF_REFERENCING is always NULL.

 

ISUPDATABLE

ISUPDATABLE

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.  

NUMERICPRECISION

NUMERICPRECISION

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

Otherwise, NULL is returned.

 

NUMERICPRECISIONRADIX

NUMERICPRECISIONRADIX

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

Otherwise, NULL is returned.

 

NUMERICSCALE

NUMERICSCALE

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

Otherwise, NULL is returned.

 

ORDINALPOSITION

ORDINALPOSITION

Column's ordinal position within the table.

 

PRIMARYKEY

PRIMARYKEY

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

 

__PROPERTYNAME

__PROPERTYNAME

private

The class property name projected to this column.

 

TABLECATALOG

TABLECATALOG

Table qualifier - always NULL in InterSystems IRIS.

 

TABLENAME

TABLENAME

Name of the table.

 

TABLESCHEMA

TABLESCHEMA

Name of schema that contains the table.

 

UNIQUECOLUMN

UNIQUECOLUMN

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