INFORMATION.SCHEMA.TABLES

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

SQL Table Name: INFORMATION_SCHEMA.TABLES

Returns one row for each table in the current namespace for which the current user has privileges.

Property Inventory

Classname
Description
ISINSERTABLEINTO
ISSHARDED
ISTYPED
Owner
REFERENCEGENERATION
SELFREFERENCINGCOLUMNNAME
TABLECATALOG
TABLENAME
TABLESCHEMA
TABLETYPE
USERDEFINEDTYPECATALOG
USERDEFINEDTYPENAME
USERDEFINEDTYPESCHEMA

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 Classname as %String (MAXLEN = 254) [ Calculated , SqlFieldName = CLASSNAME ];

Name of the class that projected this table

Property methods: ClassnameCompute(), ClassnameDisplayToLogical(), ClassnameGet(), ClassnameIsValid(), ClassnameLogicalToDisplay(), ClassnameLogicalToOdbc(), ClassnameNormalize(), ClassnameSQLCompute()

property Description as %String (MAXLEN = 254) [ Calculated , SqlFieldName = DESCRIPTION ];

Table's description

Property methods: DescriptionCompute(), DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSQLCompute()

property ISINSERTABLEINTO as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IS_INSERTABLE_INTO , Required ];

The values of IS_INSERTABLE_INTO have the following meanings:

YES - The table being described is insertable-into.
NO - The table being described is not insertable-into.

Property methods: ISINSERTABLEINTOCompute(), ISINSERTABLEINTODisplayToLogical(), ISINSERTABLEINTOGet(), ISINSERTABLEINTOIsValid(), ISINSERTABLEINTOLogicalToDisplay(), ISINSERTABLEINTOLogicalToOdbc(), ISINSERTABLEINTONormalize(), ISINSERTABLEINTOSQLCompute()

property ISSHARDED as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IS_SHARDED ];

Property methods: ISSHARDEDCompute(), ISSHARDEDDisplayToLogical(), ISSHARDEDGet(), ISSHARDEDIsValid(), ISSHARDEDLogicalToDisplay(), ISSHARDEDLogicalToOdbc(), ISSHARDEDNormalize(), ISSHARDEDSQLCompute()

property ISTYPED as %String (MAXLEN = 3) [ Calculated , SqlFieldName = IS_TYPED ];

From the standard:
A table RT whose row type is derived from a structured type ST is called a typed table. Only a base table or a view can be a typed table. A typed table has columns corresponding, in name and declared type, to every attribute of ST and one other column REFC that is the self-referencing column of RT; let REFCN be the of REFC. The declared type of REFC is necessarily REF(ST) and the nullability characteristic of REFC is known not nullable. If RT is a base table, then the table constraint "UNIQUE(REFCN)" is implicit in the definition of RT. A typed table is called a referenceable table. A self-referencing column cannot be updated. Its value is determined during the insertion of a row into the referenceable table. The value of a system-generated self-referencing column and a derived self-referencing column is automatically generated when the row is inserted into the referenceable table. The value of a user-generated self-referencing column is supplied as part of the candidate row to be inserted into the referenceable table.
InterSystems IRIS does not currently support typed tables, therefore IS_TYPED is always NO.

Property methods: ISTYPEDCompute(), ISTYPEDDisplayToLogical(), ISTYPEDGet(), ISTYPEDIsValid(), ISTYPEDLogicalToDisplay(), ISTYPEDLogicalToOdbc(), ISTYPEDNormalize(), ISTYPEDSQLCompute()

property Owner as %String (MAXLEN = 254) [ Calculated , SqlFieldName = OWNER ];

Table's owner

Property methods: OwnerCompute(), OwnerDisplayToLogical(), OwnerGet(), OwnerIsValid(), OwnerLogicalToDisplay(), OwnerLogicalToOdbc(), OwnerNormalize(), OwnerSQLCompute()

property REFERENCEGENERATION as %String (MAXLEN = 16, VALUELIST = ",SYSTEM GENERATED,USER GENERATED,DERIVED") [ Calculated , SqlFieldName = REFERENCE_GENERATION ];

From the Standard:
The values of REFERENCE_GENERATION have the following meanings: SYSTEM GENERATED - The values of the self-referencing column of the table are generated by the SQL-server. USER GENERATED - The values of the self-referencing column of the table are generated by the user. DERIVED - The values of the self-referencing column of the table are generated from columns of the table. null - The table being described does not have a self-referencing column.
Since InterSystems IRIS does not support self-referencing columns, REFERENCE_GENERATION is always null.

Property methods: REFERENCEGENERATIONCompute(), REFERENCEGENERATIONDisplayToLogical(), REFERENCEGENERATIONGet(), REFERENCEGENERATIONIsValid(), REFERENCEGENERATIONLogicalToDisplay(), REFERENCEGENERATIONLogicalToOdbc(), REFERENCEGENERATIONNormalize(), REFERENCEGENERATIONSQLCompute()

property SELFREFERENCINGCOLUMNNAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = SELF_REFERENCING_COLUMN_NAME ];

From the standard:
The value of SELF_REFERENCING_COLUMN_NAME is the name of the self-referencing column of the table, if the table is a typed table. Otherwise, the value of SELF_REFERENCING_COLUMN_NAME is the null value.
Since InterSystems IRIS does not currently support typed table (see IS_TYPED), SELF_REFERENCING_COLUMN_NAME is always NULL

Property methods: SELFREFERENCINGCOLUMNNAMECompute(), SELFREFERENCINGCOLUMNNAMEDisplayToLogical(), SELFREFERENCINGCOLUMNNAMEGet(), SELFREFERENCINGCOLUMNNAMEIsValid(), SELFREFERENCINGCOLUMNNAMELogicalToDisplay(), SELFREFERENCINGCOLUMNNAMELogicalToOdbc(), SELFREFERENCINGCOLUMNNAMENormalize(), SELFREFERENCINGCOLUMNNAMESQLCompute()

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 TABLETYPE as %String (COLLATION = "SqlUpper", MAXLEN = 16, VALUELIST = ",BASE TABLE,VIEW,GLOBAL TEMPORARY,LOCAL TEMPORARY,SYSTEM TABLE,SYSTEM VIEW,FOREIGN TABLE") [ SqlFieldName = TABLE_TYPE , Required ];

The values of TABLE_TYPE have the following meanings:

BASE TABLE - The table being described is a persistent base table.
SYSTEM TABLE - The table being described is a system persistent base table.
FOREIGN TABLE - The table being described is a foreign table, projecting data external to IRIS.
VIEW - The table being described is a viewed table.
SYSTEM VIEW - The table being described is a viewed table.
GLOBAL TEMPORARY - The table being described is a global temporary table.
LOCAL TEMPORARY - The table being described is a created local temporary table.

Property methods: TABLETYPEDisplayToLogical(), TABLETYPEGet(), TABLETYPEIsValid(), TABLETYPELogicalToDisplay(), TABLETYPELogicalToOdbc(), TABLETYPENormalize(), TABLETYPESet()

property USERDEFINEDTYPECATALOG as %String (MAXLEN = 3) [ Calculated , SqlFieldName = USER_DEFINED_TYPE_CATALOG ];

From the standard:
If the table being described is a table of a structured type TY, then the values of USER_DEFINED_TYPE_CATALOG, USER_DEFINED_TYPE_SCHEMA, and USER_DEFINED_TYPE_NAME are the fully qualified name of TY; otherwise, the values of USER_DEFINED_TYPE_CATALOG, USER_DEFINED_TYPE_SCHEMA, and USER_DEFINED_TYPE_NAME are the null value.
For InterSystems IRIS, USER_DEFINED_TYPE_CATALOG is always NULL.

Property methods: USERDEFINEDTYPECATALOGCompute(), USERDEFINEDTYPECATALOGDisplayToLogical(), USERDEFINEDTYPECATALOGGet(), USERDEFINEDTYPECATALOGIsValid(), USERDEFINEDTYPECATALOGLogicalToDisplay(), USERDEFINEDTYPECATALOGLogicalToOdbc(), USERDEFINEDTYPECATALOGNormalize(), USERDEFINEDTYPECATALOGSQLCompute()

property USERDEFINEDTYPENAME as %String (MAXLEN = 3) [ Calculated , SqlFieldName = USER_DEFINED_TYPE_NAME ];

For InterSystems IRIS, USER_DEFINED_TYPE_NAME is always NULL.

Property methods: USERDEFINEDTYPENAMECompute(), USERDEFINEDTYPENAMEDisplayToLogical(), USERDEFINEDTYPENAMEGet(), USERDEFINEDTYPENAMEIsValid(), USERDEFINEDTYPENAMELogicalToDisplay(), USERDEFINEDTYPENAMELogicalToOdbc(), USERDEFINEDTYPENAMENormalize(), USERDEFINEDTYPENAMESQLCompute()

property USERDEFINEDTYPESCHEMA as %String (MAXLEN = 3) [ Calculated , SqlFieldName = USER_DEFINED_TYPE_SCHEMA ];

For InterSystems IRIS, USER_DEFINED_TYPE_SCHEMA is always NULL.

Property methods: USERDEFINEDTYPESCHEMACompute(), USERDEFINEDTYPESCHEMADisplayToLogical(), USERDEFINEDTYPESCHEMAGet(), USERDEFINEDTYPESCHEMAIsValid(), USERDEFINEDTYPESCHEMALogicalToDisplay(), USERDEFINEDTYPESCHEMALogicalToOdbc(), USERDEFINEDTYPESCHEMANormalize(), USERDEFINEDTYPESCHEMASQLCompute()

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: SQLStorage

Maps: 2

Map number 1 is named Master

thismap.Global: ^oddSQL
Map number 2 is named rxIndex

thismap.Global: ^rINDEXSQL

^oddSQL({SchemaExact},{TableExact})

Node	Delimiter	Piece	Name
			TABLE_TYPE
		2	TABLE_SCHEMA
		3	TABLE_NAME

^rINDEXSQL("rv",$$UPPER({TABLE_SCHEMA}),$$UPPER({TABLE_NAME}))

Node	Delimiter	Piece	Name
			TableExact