This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Metadata queries

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

Syntax

Rule showStatement:

showStatement

Rule showFilter:

showFilter

Example 1: See metadata for indexes

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

  1. SHOW TABLES LIKE %
TABLE_CATTABLE_SCHEMTABLE_NAMETABLE_TYPEREMARKSTYPE_CATTYPE_SCHEMTYPE_NAMESELF_REFERENCING_COL_NAMEREF_GENERATION
docker-clusternullaccountsBASE TABLEnullnullnullnullnullnull
docker-clusternullemployees_nestedBASE TABLEnullnullnullnullnullnull

Example 2: See metadata for a specific index

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

  1. SHOW TABLES LIKE acc%
TABLE_CATTABLE_SCHEMTABLE_NAMETABLE_TYPEREMARKSTYPE_CATTYPE_SCHEMTYPE_NAMESELF_REFERENCING_COL_NAMEREF_GENERATION
docker-clusternullaccountsBASE TABLEnullnullnullnullnullnull

Example 3: See metadata for fields

To see metadata for field names that match a specific pattern, use the DESCRIBE command:

  1. DESCRIBE TABLES LIKE accounts
TABLE_CATTABLE_SCHEMTABLE_NAMECOLUMN_NAMEDATA_TYPETYPE_NAMECOLUMN_SIZEBUFFER_LENGTHDECIMAL_DIGITSNUM_PREC_RADIXNULLABLEREMARKSCOLUMN_DEFSQL_DATA_TYPESQL_DATETIME_SUBCHAR_OCTET_LENGTHORDINAL_POSITIONIS_NULLABLESCOPE_CATALOGSCOPE_SCHEMASCOPE_TABLESOURCE_DATA_TYPEIS_AUTOINCREMENTIS_GENERATEDCOLUMN
docker-clusternullaccountsaccount_numbernulllongnullnullnull102nullnullnullnullnull1 nullnullnullnullNO 
docker-clusternullaccountsfirstnamenulltextnullnullnull102nullnullnullnullnull2 nullnullnullnullNO 
docker-clusternullaccountsaddressnulltextnullnullnull102nullnullnullnullnull3 nullnullnullnullNO 
docker-clusternullaccountsbalancenulllongnullnullnull102nullnullnullnullnull4 nullnullnullnullNO 
docker-clusternullaccountsgendernulltextnullnullnull102nullnullnullnullnull5 nullnullnullnullNO 
docker-clusternullaccountscitynulltextnullnullnull102nullnullnullnullnull6 nullnullnullnullNO 
docker-clusternullaccountsemployernulltextnullnullnull102nullnullnullnullnull7 nullnullnullnullNO 
docker-clusternullaccountsstatenulltextnullnullnull102nullnullnullnullnull8 nullnullnullnullNO 
docker-clusternullaccountsagenulllongnullnullnull102nullnullnullnullnull9 nullnullnullnullNO 
docker-clusternullaccountsemailnulltextnullnullnull102nullnullnullnullnull10 nullnullnullnullNO 
docker-clusternullaccountslastnamenulltextnullnullnull102nullnullnullnullnull11 nullnullnullnullNO