Query information about tables - Tablestore - Alibaba Cloud Documentation Center

You can execute the describe statement to query information about tables, such as the field names and field types.

Note For more information about the describe statement, see Query the information about a table.

Prerequisites

A Tablestore client is initialized. For more information, see Initialization.
A mapping table is created. For more information, see Create mapping tables.

Parameters


Parameter	Description
query	The SQL statement. Configure the parameter based on the required feature.

Examples

Execute the describe test_table statement to query information about the table named test_table.

const params = {
  query: "describe test_table",
}

client.sqlQuery(params, function (err, data) {
  if (err) {
    console.log('sqlQuery error:', err.toString());
  } else {
    console.log('sqlQuery success:', data);
  }
});