Link Search Menu Expand Document Documentation Menu

SQL metadata queries

To view basic metadata about your indexes, use the SHOW and DESCRIBE commands.

Syntax

Rule showStatement:

showStatement

Rule showFilter:

showFilter

Example 1: View metadata for indexes

To view metadata for indexes that match a specific pattern, use the SHOW command. Use the wildcard % to match all indexes:

SHOW TABLES LIKE %

The query returns the following results:

TABLE_CAT TABLE_SCHEM TABLE_NAME TABLE_TYPE REMARKS TYPE_CAT TYPE_SCHEM TYPE_NAME SELF_REFERENCING_COL_NAME REF_GENERATION
docker-cluster null accounts BASE TABLE null null null null null null
docker-cluster null employees_nested BASE TABLE null null null null null null

Example 2: View metadata for a specific index

To view metadata for an index name with a prefix of acc:

SHOW TABLES LIKE acc%

The query returns the following results:

TABLE_CAT TABLE_SCHEM TABLE_NAME TABLE_TYPE REMARKS TYPE_CAT TYPE_SCHEM TYPE_NAME SELF_REFERENCING_COL_NAME REF_GENERATION
docker-cluster null accounts BASE TABLE null null null null null null

Example 3: View metadata for all fields in an index

To view metadata for all fields in indexes that match a specific pattern, use the DESCRIBE command:

DESCRIBE TABLES LIKE accounts

The query returns the following results:

TABLE_CAT TABLE_SCHEM TABLE_NAME COLUMN_NAME DATA_TYPE TYPE_NAME COLUMN_SIZE BUFFER_LENGTH DECIMAL_DIGITS NUM_PREC_RADIX NULLABLE REMARKS COLUMN_DEF SQL_DATA_TYPE SQL_DATETIME_SUB CHAR_OCTET_LENGTH ORDINAL_POSITION IS_NULLABLE SCOPE_CATALOG SCOPE_SCHEMA SCOPE_TABLE SOURCE_DATA_TYPE IS_AUTOINCREMENT IS_GENERATEDCOLUMN
docker-cluster null accounts account_number null long null null null 10 2 null null null null null 1   null null null null NO  
docker-cluster null accounts firstname null text null null null 10 2 null null null null null 2   null null null null NO  
docker-cluster null accounts address null text null null null 10 2 null null null null null 3   null null null null NO  
docker-cluster null accounts balance null long null null null 10 2 null null null null null 4   null null null null NO  
docker-cluster null accounts gender null text null null null 10 2 null null null null null 5   null null null null NO  
docker-cluster null accounts city null text null null null 10 2 null null null null null 6   null null null null NO  
docker-cluster null accounts employer null text null null null 10 2 null null null null null 7   null null null null NO  
docker-cluster null accounts state null text null null null 10 2 null null null null null 8   null null null null NO  
docker-cluster null accounts age null long null null null 10 2 null null null null null 9   null null null null NO  
docker-cluster null accounts email null text null null null 10 2 null null null null null 10   null null null null NO  
docker-cluster null accounts lastname null text null null null 10 2 null null null null null 11   null null null null NO  

Example 4: View metadata for specific fields

To view metadata only for fields whose names match a specific pattern, add the COLUMNS LIKE clause to the DESCRIBE command. The following query returns metadata for the fields in the accounts index whose names end in name:

DESCRIBE TABLES LIKE accounts COLUMNS LIKE %name

The query returns the following results:

TABLE_CAT TABLE_SCHEM TABLE_NAME COLUMN_NAME DATA_TYPE TYPE_NAME COLUMN_SIZE BUFFER_LENGTH DECIMAL_DIGITS NUM_PREC_RADIX NULLABLE REMARKS COLUMN_DEF SQL_DATA_TYPE SQL_DATETIME_SUB CHAR_OCTET_LENGTH ORDINAL_POSITION IS_NULLABLE SCOPE_CATALOG SCOPE_SCHEMA SCOPE_TABLE SOURCE_DATA_TYPE IS_AUTOINCREMENT IS_GENERATEDCOLUMN
docker-cluster null accounts firstname null text null null null 10 2 null null null null null 1   null null null null NO  
docker-cluster null accounts lastname null text null null null 10 2 null null null null null 2   null null null null NO