elasticsearch/docs/reference/query-languages/sql/sql-syntax-show-tables.md
Craig Taverner 94cad286bc
Restructure query-languages docs files for clarity (#124797)
In a few previous PR's we restructured the ES|QL docs to make it possible to generate them dynamically.

This PR just moves a few files around to make the query languages docs easier to work with, and a little more organized like the ES|QL docs.

A bit part of this was setting up redirects to the new locations, so other repo's could correctly link to the elasticsearch docs.
2025-03-17 17:58:58 +01:00

2.9 KiB

mapped_pages
https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-syntax-show-tables.html

SHOW TABLES [sql-syntax-show-tables]

SHOW TABLES
    [CATALOG [catalog_identifier | <1>
              LIKE pattern]]?      <2>
    [INCLUDE FROZEN]?              <3>
    [table_identifier |            <4>
     LIKE pattern]?                <5>
  1. Catalog (cluster) identifier. Supports wildcards (*).
  2. SQL LIKE pattern matching catalog names.
  3. Whether or not to include frozen indices.
  4. Single table (index or data stream) identifier or double-quoted multi-target pattern.
  5. SQL LIKE pattern matching table names.

See index patterns for more information about patterns.

Description: List the tables available to the current user and their type.

SHOW TABLES;

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |emp            |TABLE     |INDEX
javaRestTest      |employees      |VIEW      |ALIAS
javaRestTest      |library        |TABLE     |INDEX

Match multiple indices by using {{es}} multi-target syntax notation:

SHOW TABLES "*,-l*";

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |emp            |TABLE     |INDEX
javaRestTest      |employees      |VIEW      |ALIAS

One can also use the LIKE clause to restrict the list of names to the given pattern.

The pattern can be an exact match:

SHOW TABLES LIKE 'emp';

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |emp            |TABLE     |INDEX

Multiple chars:

SHOW TABLES LIKE 'emp%';

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |emp            |TABLE     |INDEX
javaRestTest      |employees      |VIEW      |ALIAS

A single char:

SHOW TABLES LIKE 'em_';

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |emp            |TABLE     |INDEX

Or a mixture of single and multiple chars:

SHOW TABLES LIKE '%em_';

 catalog       |     name      | type     |     kind
---------------+---------------+----------+---------------
javaRestTest      |emp            |TABLE     |INDEX

List tables within remote clusters whose names are matched by a wildcard:

SHOW TABLES CATALOG 'my_*' LIKE 'test_emp%';

     catalog     |     name      |     type      |     kind
-----------------+---------------+---------------+---------------
my_remote_cluster|test_emp       |TABLE          |INDEX
my_remote_cluster|test_emp_copy  |TABLE          |INDEX