On this page 
Warning:
CockroachDB v19.1 is no longer supported as of October 30, 2020. For more details, refer to the Release Support Policy.
The SHOW COLUMNS statement shows details about columns in a table, including each column's name, type, default value, and whether or not it's nullable.
Required privileges
The user must have any privilege on the target table.
Synopsis
Parameters
| Parameter | Description |
|---|---|
table_name |
The name of the table for which to show columns. |
Response
The following fields are returned for each column.
| Field | Description |
|---|---|
column_name |
The name of the column. |
data_type |
The data type of the column. |
is_nullable |
Whether or not the column accepts NULL. Possible values: true or false. |
column_default |
The default value for the column, or an expression that evaluates to a default value. |
generation_expression |
The expression used for a computed column. |
indices |
The list of indexes that the column is involved in, as an array. |
is_hidden |
Whether or not the column is hidden. Possible values: true or false. |
Examples
> CREATE TABLE orders (
id INT PRIMARY KEY DEFAULT unique_rowid(),
date TIMESTAMP NOT NULL,
priority INT DEFAULT 1,
customer_id INT UNIQUE,
status STRING DEFAULT 'open',
CHECK (priority BETWEEN 1 AND 5),
CHECK (status in ('open', 'in progress', 'done', 'cancelled')),
FAMILY (id, date, priority, customer_id, status)
);
> SHOW COLUMNS FROM orders;
column_name | data_type | is_nullable | column_default | generation_expression | indices | is_hidden
+-------------+-----------+-------------+-----------------+-----------------------+--------------------------------------+-----------+
id | INT | false | unique_rowid() | | {"primary","orders_customer_id_key"} | false
date | TIMESTAMP | false | NULL | | {} | false
priority | INT | true | 1:::INT | | {} | false
customer_id | INT | true | NULL | | {"orders_customer_id_key"} | false
status | STRING | true | 'open':::STRING | | {} | false
(5 rows)
> CREATE TABLE foo (x INT);
> SHOW COLUMNS FROM foo;
column_name | data_type | is_nullable | column_default | generation_expression | indices | is_hidden
+-------------+-----------+-------------+----------------+-----------------------+-------------+-----------+
x | INT | true | NULL | | {} | false
rowid | INT | false | unique_rowid() | | {"primary"} | true
(2 rows)
See also
Was this helpful?
