column list

Prev Next

This command lists columns in a VAST Database table.

Usage

column list --database-name DATABASE 
            --schema-name SCHEMA
            --table-name TABLE
           [--page PAGE]
           [--page-size PAGE_SIZE]
           [--name COLUMN_NAME]
           [--name-startswith PREFIX]
           [--tenant-id TENANT]

Required Parameters

--database-name DATABASE

Specifies the name of the database containing the table.

--schema-name SCHEMA

Specifies the name of the schema containing the table.

--table-name TABLE

Specifies the name of the table containing the columns.

Options

--page PAGE

Specifies the specific page in the output list, by its number. This parameter is used only  if page-size is set. Default is the first page.

--page-size PAGE_SIZE

Specifies the maximum number of columns to list per output page. Default: 100.

--name COLUMN_NAME

Specifies the name of a specific column.

--name-startswith PREFIX

Specifies a prefix to filter the column names.

--tenant-id TENANT

Enter the ID of the tenant where the database resides

If omitted, the default tenant is assumed.

Example

vcli: admin> column list --database-name table-1 --schema-name schema_jypxvnuobg --table-name table_jypxvnuobg
+--------------+-------------------+----------------------------------+-------------------+------------------+
| Name         | Raw-field         | Database-name                    | Schema-name       | Table-name       |
+--------------+-------------------+----------------------------------+-------------------+------------------+
| theage       | int8              | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thestate     | string            | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thedate      | date32[day]       | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thetinyint   | int8              | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| theint       | int32             | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thebigint    | int64             | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thetime      | time32[ms]        | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thetimestamp | timestamp[ms]     | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thevarchar   | string            | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thebool      | bool              | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thereal      | float             | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thedouble    | double            | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
| thedecimal   | decimal128(38, 0) | table-1                          | schema_jypxvnuobg | table_jypxvnuobg |
+--------------+-------------------+----------------------------------+-------------------+------------------+