com.simba.dsi.dataengine.utilities
Enum MetadataSourceID

java.lang.Object
  extended by java.lang.Enum<MetadataSourceID>
      extended by com.simba.dsi.dataengine.utilities.MetadataSourceID
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MetadataSourceID>

public enum MetadataSourceID
extends java.lang.Enum<MetadataSourceID>

A MetadataSourceID value identifies a specific metadata source that can retrieved using IDataEngine.makeMetadataSource(). Each metadata source is associated with a specific ordered group of columns.


Enum Constant Summary
ATTRIBUTES
          ATTRIBUTES: Table containing metadata for the attributes of user defined types.
CATALOG_ONLY
          CATALOG_ONLY: Table containing list of catalogs in the data source.
CATALOG_SCHEMA_ONLY
          CATALOG_SCHEMA_ONLY: Table containing catalog and schema metadata of the data source.
COLUMN_PRIVILEGES
          COLUMN_PRIVILEGES: Table containing metadata for the column privileges defined in the data source.
COLUMNS
          COLUMNS: Table containing metadata for the columns defined in the data source.
FOREIGN_KEYS
          FOREIGN_KEYS: Table containing foreign key metadata for tables defined in the data source.
FUNCTION_COLUMNS_JDBC4
          FUNCTION_COLUMNS_JDBC4 : Table containing metadata for the given catalog's system or user function parameters and return type.
FUNCTIONS_JDBC4
          FUNCTIONS_JDBC4 : Table containing metadata for available sytem and user functions.
PRIMARY_KEYS
          PRIMARY_KEYS: Table containing primary key metadata for tables defined in the data source.
PROCEDURE_COLUMNS
          PROCEDURE_COLUMNS: Table containing metadata for the columns of procedures in the data source.
PROCEDURES
          PROCEDURES: Table containing metadata of procedures defined in the data source.
PSEUDO_COLUMNS_JDBC41
          PSEUDO_COLUMNS_JDBC41 : Table containing metadata for pseudo or hidden columns available in a given table within the specified catalog and schema.
SCHEMA_ONLY
          SCHEMA_ONLY: Table containing list of schemas in the data source.
SPECIAL_COLUMNS
          SPECIAL_COLUMNS: Table containing metadata for the special columns defined in the data source.
STATISTICS
          STATISTICS: Table containing metadata for the statistics for tables defined in the data source.
SUPERTABLES
          SUPERTABLES: Table containing metadata for the description of the table hierarchies defined in a particular schema in this database.
SUPERTYPES
          SUPERTYPES: Table containing metadata for the description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
TABLE_PRIVILEGES
          TABLE_PRIVILEGES: Table containing metadata for the privileges tables defined in the data source.
TABLES
          TABLES: Table containing table metadata of tables in the data source.
TABLETYPE_ONLY
          TABLETYPE_ONLY: Table containing list of table types in the data source.
TYPE_INFO
          TYPE_INFO: Table containing metadata for the types defined in the data source.
UDT
          UDT: Table containing metadata for the description of the user-defined type (UDT) hierarchies defined in a particular schema in this database.
 
Method Summary
static MetadataSourceID valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MetadataSourceID[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

TABLES

public static final MetadataSourceID TABLES
TABLES: Table containing table metadata of tables in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. TABLE_NAME: Table Name - VARCHAR
  4. TABLE_TYPE: Table Type - VARCHAR
  5. REMARKS: Remarks - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


CATALOG_ONLY

public static final MetadataSourceID CATALOG_ONLY
CATALOG_ONLY: Table containing list of catalogs in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
No restrictions will be used.

The result set returned by this table must be ordered by:


SCHEMA_ONLY

public static final MetadataSourceID SCHEMA_ONLY
SCHEMA_ONLY: Table containing list of schemas in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
No restrictions will be used.

The result set returned by this table must be ordered by:


TABLETYPE_ONLY

public static final MetadataSourceID TABLETYPE_ONLY
TABLETYPE_ONLY: Table containing list of table types in the data source.

The metadata result representing this table will have the following output columns in this order:

  1. TABLE_TYPE: Table Type - VARCHAR
No restrictions will be used.

The result set returned by this table must be ordered by:


TABLE_PRIVILEGES

public static final MetadataSourceID TABLE_PRIVILEGES
TABLE_PRIVILEGES: Table containing metadata for the privileges tables defined in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. TABLE_NAME: Table Name - VARCHAR (not null)
  4. GRANTOR: Grantor - VARCHAR
  5. GRANTEE: Grantee - VARCHAR (not null)
  6. PRIVILEGE: Privilege - VARCHAR (not null)
  7. ISGRANTABLE: Is Grantable - VARCHAR. This value should be one of the strings "YES" or "NO"
The following restrictions are used, in order: The result set returned by this table must be ordered by:


COLUMNS

public static final MetadataSourceID COLUMNS
COLUMNS: Table containing metadata for the columns defined in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. TABLE_NAME: Table Name - VARCHAR (not null)
  4. COLUMN_NAME: Column Name - VARCHAR (not null)
  5. DATA_TYPE: Data Type - SMALLINT (not null). Valid values are defined in java.sql.Types
  6. DATA_TYPE_NAME: Type Name - VARCHAR (not null)
  7. COLUMN_SIZE: Column Size - INTEGER
  8. BUFFER_LENGTH: Buffer Length - INTEGER
  9. DECIMAL_DIGITS: Decimal Digits - SMALLINT
  10. NUM_PREC_RADIX: Numeric Precision Radix - SMALLINT
  11. NULLABLE: Nullable - SMALLINT (not null). Valid values are listed in MetadataConstants under Nullability Constants.
  12. REMARKS: Remarks - VARCHAR
  13. COLUMN_DEF: Column Default - VARCHAR
  14. SQL_DATA_TYPE: SQL Data Type - INTEGER
  15. SQL_DATETIME_SUB: SQL Date/Time Sub - INTEGER
  16. CHAR_OCTET_LENGTH: Character Octet Length - INTEGER
  17. ORDINAL_POSITION: Ordinal Position - INTEGER
  18. IS_NULLABLE: Is Nullable - VARCHAR
  19. IS_AUTOINCREMENT: Is Autoincrement - VARCHAR
  20. USER_DATA_TYPE: User Data Type - SMALLINT
  21. IS_GENERATEDCOLUMN: Is GeneratedColumn - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


COLUMN_PRIVILEGES

public static final MetadataSourceID COLUMN_PRIVILEGES
COLUMN_PRIVILEGES: Table containing metadata for the column privileges defined in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. TABLE_NAME: Table Name - VARCHAR (not null)
  4. COLUMN_NAME: Column Name - VARCHAR (not null)
  5. GRANTOR: Grantor - VARCHAR
  6. GRANTEE: Grantee - VARCHAR (not null)
  7. PRIVILEGE: Privilege - VARCHAR (not null)
  8. ISGRANTABLE: Is Grantable - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


FOREIGN_KEYS

public static final MetadataSourceID FOREIGN_KEYS
FOREIGN_KEYS: Table containing foreign key metadata for tables defined in the data source.

The metadata result representing this table will have the following output columns in this order:

  1. PRIMARY_KEY_CATALOG_NAME: Primary Key Table Catalog Name - VARCHAR
  2. PRIMARY_KEY_SCHEMA_NAME: Primary Key Table Schema Name - VARCHAR
  3. PRIMARY_KEY_TABLE_NAME: Primary Key Table Name - VARCHAR (not null)
  4. PRIMARY_KEY_COLUMN_NAME: Primary Key Column Name - VARCHAR (not null)
  5. FOREIGN_KEY_CATALOG_NAME: Key Table Catalog Name - VARCHAR
  6. FOREIGN_KEY_SCHEMA_NAME: Foreign Key Table Schema Name - VARCHAR
  7. FOREIGN_KEY_TABLE_NAME: Foreign Key Table Name - VARCHR (not null)
  8. FOREIGN_KEY_COLUMN_NAME: Foreign Key Column Name - VARCHAR (not null)
  9. KEY_SEQ: Column Sequence Number For Key - SMALLINT (not null). Column numbers should use 1-based indexing.
  10. FOREIGN_KEY_UPDATE_RULE: Update Rule - SMALLINT
  11. FOREIGN_KEY_DELETE_RULE: Delete Rule - SMALLINT
  12. FOREIGN_KEY_NAME: Foreign Key Name - VARCHAR
  13. PRIMARY_KEY_NAME: Primary Key Name - VARCHAR
  14. DEFERRABILITY: Deferrability - SMALLINT. Valid values are listed in MetadataConstants under Deferrability Constants
The following restrictions are used, in order: If the foreign keys associated with a primary key are requested, the result set returned by this table must be ordered by: If the primary keys associated with a foreign key are requested, the result set returned by this table must be ordered by:


PRIMARY_KEYS

public static final MetadataSourceID PRIMARY_KEYS
PRIMARY_KEYS: Table containing primary key metadata for tables defined in the data source.

The metadata result representing this table will have the following output columns in this order:

  1. PRIMARY_KEY_CATALOG_NAME: Catalog Name - VARCHAR
  2. PRIMARY_KEY_SCHEMA_NAME: Schema Name - VARCHAR
  3. PRIMARY_KEY_TABLE_NAME: Table Name - VARCHAR (not null)
  4. PRIMARY_KEY_COLUMN_NAME: Column Name - VARCHAR (not null)
  5. KEY_SEQ: Column Sequence Number For Key - SMALLINT (not null). Column numbers should use 1-based indexing.
  6. PRIMARY_KEY_NAME: Primary Key Name - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


SPECIAL_COLUMNS

public static final MetadataSourceID SPECIAL_COLUMNS
SPECIAL_COLUMNS: Table containing metadata for the special columns defined in the data source.

The metadata result representing this table will have the following output columns defined by SimbaLib:

  1. SCOPE: Scope - SMALLINT. Valid values are listed in MetadataConstants under Scope Constants
  2. COLUMN_NAME: Column Name - VARCHAR (not null)
  3. DATA_TYPE: Data Type - SMALLINT (not null). Valid values are defined by java.sql.Types
  4. DATA_TYPE_NAME: Type Name - VARCHAR (not null)
  5. COLUMN_SIZE: Column Size - INTEGER
  6. BUFFER_LENGTH: Buffer Length - INTEGER
  7. DECIMAL_DIGITS: Decimal Digits - SMALLINT
  8. PSEUDO: Pseudo Column - SMALLINT. Valid values are listed in MetadataConstants under Pseudo Column Constants
The following restrictions are used, in order: The result set provided by the DSII must be ordered by:


STATISTICS

public static final MetadataSourceID STATISTICS
STATISTICS: Table containing metadata for the statistics for tables defined in the data source.

The metadata result representing this table will have the following output columns in this order:

NOTE: All index-related columns should have a null entry if the corresponding entry for Statistics Type is MetadataConstants.TABLE_STAT (columns 4, 5, 6, 8, 9, 10, and 13).

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. TABLE_NAME: Table Name - VARCHAR (not null)
  4. NON_UNIQUE_INDEX: Index Allows Duplicates - SMALLINT. Valid values are defined in MetadataConstants under Uniqueness Constants
  5. INDEX_QUALIFIER: Index Qualifier - VARCHAR
  6. INDEX_NAME: Index Name - VARCHAR.
  7. INDEX_TYPE: Statistics Type - SMALLINT (not null). Valid values are defined in MetadataConstants under Statistics Type Constants
  8. ORDINAL_POSITION: Index Ordinal Position - SMALLINT. This should be the index's column sequence number or null.
  9. COLUMN_NAME: Index Column Name - VARCHAR
  10. INDEX_SORT_SEQUENCE: Index Ascending or Descending - CHAR(1). Valid values for this are "A" for ascending, "D" for descending order
  11. INDEX_CARDINALITY: Cardinality - INTEGER
  12. INDEX_PAGES: Pages - INTEGER
  13. INDEX_FILTER_CONDITION: Index Filter Condition - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


PROCEDURES

public static final MetadataSourceID PROCEDURES
PROCEDURES: Table containing metadata of procedures defined in the data source.

The metadata result representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. PROCEDURE_NAME: Procedure Name - VARCHAR (not null)
  4. NUM_INPUT_PARAMS: Number of Input Parameters - INTEGER. This column is reserved unused
  5. NUM_OUTPUT_PARAMS: Number of Output Parameters - INTEGER. This column is reserved unused
  6. NUM_RESULT_SETS: Number of Result Sets - INTEGER. This column is reserved unused
  7. REMARKS: Remarks - VARCHAR
  8. PROCEDURE_TYPE: Procedure Type - SMALLINT. Valid values are listed in MetadataConstants under Procedure Type Constants
  9. SPECIFIC_NAME: Name which uniquely identifies this function within its schema - VARCHAR (not null)
The following restrictions are used, in order: The result set returned by this table must be ordered by:


PROCEDURE_COLUMNS

public static final MetadataSourceID PROCEDURE_COLUMNS
PROCEDURE_COLUMNS: Table containing metadata for the columns of procedures in the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
  3. PROCEDURE_NAME: Procedure Name - VARCHAR (not null)
  4. COLUMN_NAME: Column Name - VARCHAR (not null)
  5. PROCEDURE_COLUMN_TYPE - SMALLINT (not null). Valid values are defined in MetadataConstants under PCT (Procedure Column Types).
  6. DATA_TYPE: Data Type - SMALLINT (not null). Valid values are defined in java.sql.Types
  7. DATA_TYPE_NAME: Type Name - VARCHAR (not null)
  8. COLUMN_SIZE: Column Size - INTEGER
  9. BUFFER_LENGTH: Buffer Length - INTEGER
  10. DECIMAL_DIGITS: Decimal Digits - SMALLINT
  11. NUM_PREC_RADIX: Numeric Precision Radix - SMALLINT
  12. NULLABLE: Nullable - SMALLINT (not null). Valid values are listed in MetadataConstants under Nullability Constants.
  13. REMARKS: Remarks - VARCHAR
  14. COLUMN_DEF: Default value for the columns - VARCHAR
  15. SQL_DATA_TYPE: Reserved for future use - SMALLINT
  16. SQL_DATETIME_SUB: Reserved for future use - SMALLINT
  17. CHAR_OCTET_LENGTH: The maximum length of binary and character based columns - INTEGER
  18. ORDINAL_POSITION: The ordinal position, starting from 1, for the input and output parameters. - INTEGER (not null)
  19. IS_NULLABLE: Is Nullable - VARCHAR (not null)
  20. SPECIFIC_NAME: Name which uniquely identifies this function within its schema - VARCHAR (not null)
  21. IS_RESULT_SET: Indicate if the current row is a parameter or result set column. VARCHAR (not null)
  22. USER_DATA_TYPE: Identifies the User Data Type - SMALLINT
The following restrictions are used, in order: The result set returned by this table must be ordered by:


TYPE_INFO

public static final MetadataSourceID TYPE_INFO
TYPE_INFO: Table containing metadata for the types defined in the data source. All types used in the data source must have a row in this table.

The metadata result representing this table will have the following output columns in this order:

  1. DATA_TYPE_NAME: Type Name - VARCHAR (not null)
  2. DATA_TYPE: Data Type - SMALLINT (not null). Valid values are defined by java.sql.Types
  3. COLUMN_SIZE: Column Size - INTEGER
  4. LITERAL_PREFIX: Literal Prefix - VARCHAR
  5. LITERAL_SUFFIX: Literal Suffix - VARCHAR
  6. CREATE_PARAM: Creation Parameters - VARCHAR
  7. NULLABLE: Nullability - SMALLINT (not null). Valid values are listed in MetadataConstants under Nullability Constants
  8. CASE_SENSITIVE: Case Sensitivity - SMALLINT (not null). Valid values are listed in MetadataConstants under Case Sensitivity Constants
  9. SEARCHABLE: Searchability - SMALLINT (not null). Valid values are listed in MetadataConstants under Searchability Constants
  10. UNSIGNED_ATTRIBUTE: Signedness - SMALLINT. Valid values are listed in MetadataConstants under Signedness Constants
  11. FIXED_PREC_SCALE: Fixed Precision Scale - SMALLINT (not null). Valid values are listed in MetadataConstants under Fixed Precision Scale Constants
  12. AUTO_UNIQUE: Auto Unique Data Type - SMALLINT. Valid values are listed under MetadataConstants under Auto Unique Constants
  13. LOCAL_TYPE_NAME: Local Type Name - VARCHAR
  14. MINIMUM_SCALE: Minimum Scale - SMALLINT
  15. MAXIMUM_SCALE: Maximum Scale - SMALLINT
  16. SQL_DATA_TYPE: SQL Data Type - INTEGER
  17. SQL_DATETIME_SUB: SQL Datetime Sub - INTEGER
  18. NUM_PREC_RADIX: Numeric Precision Radix - SMALLINT
The result set returned by this table must be ordered by:


CATALOG_SCHEMA_ONLY

public static final MetadataSourceID CATALOG_SCHEMA_ONLY
CATALOG_SCHEMA_ONLY: Table containing catalog and schema metadata of the data source.

The metadata result set representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Catalog Name - VARCHAR
  2. SCHEMA_NAME: Schema Name - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


ATTRIBUTES

public static final MetadataSourceID ATTRIBUTES
ATTRIBUTES: Table containing metadata for the attributes of user defined types. All types used in the data source must have a row in this table.

The metadata result representing this table will have the following output columns in this order:

  1. TYPE_CAT - VARCHAR
  2. TYPE_SCHEM - VARCHAR
  3. TYPE_NAME - VARCHAR (not null)
  4. ATTR_NAME - VARCHAR (not null)
  5. DATA_TYPE - INTEGER not null)
  6. ATTR_TYPE_NAME - VARCHAR (not null)
  7. ATTR_SIZE - INTEGER (not null)
  8. DECIMAL_DIGITS - INTEGER (not null)
  9. NUM_PREC_RADIX - INTEGER (not null)
  10. NULLABLE - INTEGER (not null)
  11. REMARKS - VARCHAR
  12. ATTR_DEF - VARCHAR
  13. SQL_DATA_TYPE - INTEGER => unused
  14. SQL_DATETIME_SUB - INTEGER => unused
  15. CHAR_OCTET_LENGTH - INTEGER
  16. ORDINAL_POSITION - INTEGER (not null)
  17. IS_NULLABLE - VARCHAR (not null)
  18. SCOPE_CATALOG - VARCHAR
  19. SCOPE_SCHEMA - VARCHAR
  20. SCOPE_TABLE - VARCHAR
  21. SOURCE_DATA_TYPE - SMALLINT


SUPERTABLES

public static final MetadataSourceID SUPERTABLES
SUPERTABLES: Table containing metadata for the description of the table hierarchies defined in a particular schema in this database.

The metadata result representing this table will have the following output columns in this order:

  1. TABLE_CAT - VARCHAR
  2. TABLE_SCHEM - VARCHAR
  3. TABLE_NAME - VARCHAR (not null)
  4. SUPERTABLE_NAME - VARCHAR (not null)


SUPERTYPES

public static final MetadataSourceID SUPERTYPES
SUPERTYPES: Table containing metadata for the description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.

The metadata result representing this table will have the following output columns in this order:

  1. TYPE_CAT - VARCHAR
  2. TYPE_SCHEM - VARCHAR
  3. TYPE_NAME - VARCHAR (not null)
  4. SUPERTYPE_CAT - VARCHAR
  5. SUPERTYPE_SCHEM - VARCHAR
  6. SUPERTYPE_NAME - VARCHAR (not null)


UDT

public static final MetadataSourceID UDT
UDT: Table containing metadata for the description of the user-defined type (UDT) hierarchies defined in a particular schema in this database. Only the immediate super type/ sub type relationship is modeled.

The metadata result representing this table will have the following output columns in this order:

  1. TYPE_CAT - VARCHAR
  2. TYPE_SCHEM - VARCHAR
  3. TYPE_NAME - VARCHAR (not null)
  4. CLASS_NAME - VARCHAR (not null)
  5. DATA_TYPE - INTEGER (not null)
  6. REMARKS - VARCHAR
  7. BASE_TYPE - SMALLINT


FUNCTIONS_JDBC4

public static final MetadataSourceID FUNCTIONS_JDBC4
FUNCTIONS_JDBC4 : Table containing metadata for available sytem and user functions.

The metadata result representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Function catalog - VARCHAR
  2. SCHEMA_NAME: Function schema - VARCHAR
  3. PROCEDURE_NAME: Function name - VARCHAR (not null)
  4. REMARKS: Explanatory comment on the function - VARCHAR
  5. PROCEDURE_TYPE: kind of function - SMALLINT (not null)
  6. SPECIFIC_NAME: Name which uniquely identifies this function within its schema - VARCHAR
The following restrictions are used, in order: The result set returned by this table must be ordered by:


FUNCTION_COLUMNS_JDBC4

public static final MetadataSourceID FUNCTION_COLUMNS_JDBC4
FUNCTION_COLUMNS_JDBC4 : Table containing metadata for the given catalog's system or user function parameters and return type.

The metadata result representing this table will have the following output columns in this order:

  1. CATALOG_NAME: Function catalog - VARCHAR
  2. SCHEMA_NAME: Function schema - VARCHAR
  3. PROCEDURE_NAME: Function name - VARCHAR (not null)
  4. COLUMN_NAME: Column/Parameter name - VARCHAR
  5. PROCEDURE_COLUMN_TYPE - SMALLINT (not null). Valid values are defined in ParameterType.
  6. DATA_TYPE: Data Type - SMALLINT (not null). Valid values are defined in java.sql.Types
  7. DATA_TYPE_NAME: Type Name - VARCHAR (not null)
  8. COLUMN_SIZE: Precision - INTEGER (not null)
  9. BUFFER_LENGTH: Length - INTEGER (not null)
  10. DECIMAL_DIGITS: Scale - SMALLINT (not null)
  11. NUM_PREC_RADIX: Radix - SMALLINT (not null)
  12. NULLABLE: Nullable - SMALLINT (not null). Valid values are listed in MetadataConstants.
  13. REMARKS: Explanatory comment on the function - VARCHAR
  14. CHAR_OCTET_LENGTH: The maximum length of binray and character based paremeters and columns - INTEGER (not null)
  15. ORDINAL_POSITION: The ordinal position, starting from 1, for the input and output parameters. - INTEGER (not null)
  16. IS_NULLABLE: Is Nullable - VARCHAR (not null)
  17. SPECIFIC_NAME: Name which uniquely identifies this function within its schema - VARCHAR (not null)
  18. USER_DATA_TYPE: Identifies the User Data Type - SMALLINT
The following restrictions are used, in order: The result set returned by this table must be ordered by:


PSEUDO_COLUMNS_JDBC41

public static final MetadataSourceID PSEUDO_COLUMNS_JDBC41
PSEUDO_COLUMNS_JDBC41 : Table containing metadata for pseudo or hidden columns available in a given table within the specified catalog and schema.

The metadata result representing this table will have the following output columns in this order:

  1. TABLE_CAT String => table catalog (may be null)
  2. TABLE_SCHEM String => table schema (may be null)
  3. TABLE_NAME String => table name
  4. COLUMN_NAME String => column name
  5. DATA_TYPE int => SQL type from java.sql.Types
  6. COLUMN_SIZE int => column size.
  7. DECIMAL_DIGITS int => the number of fractional digits. Null is returned for data types where DECIMAL_DIGITS is not applicable.
  8. NUM_PREC_RADIX int => Radix (typically either 10 or 2)
  9. COLUMN_USAGE String => The allowed usage for the column. The value returned will correspond to the enum name returned by PseudoColumnUsage.name()
  10. REMARKS String => comment describing column (may be null)
  11. CHAR_OCTET_LENGTH int => for char types the maximum number of bytes in the column
  12. IS_NULLABLE String => ISO rules are used to determine the nullability for a column.
    • YES --- if the column can include NULLs
    • NO --- if the column cannot include NULLs
    • empty string --- if the nullability for the column is unknown

Method Detail

values

public static MetadataSourceID[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (MetadataSourceID c : MetadataSourceID.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static MetadataSourceID valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.