Get

/columns/

This endpoint lists Database Table Columns.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Query parameters

page

integer

Minimum1

page_size

integer

Minimum1

Maximum999

Default999

tenant_id

integer

Filter by tenant. Specify tenant ID.

Minimum1

database_name

stringRequired

Getting list of objects by database_name

schema_name

stringRequired

Getting list of objects by schema_name

table_name

stringRequired

Getting list of objects by table_name

list_sorted_columns

boolean

List only columns that are sorted.

is_imports_table

boolean

Is table actually a sub-table to track imported .parquet files.

name

string

Getting list of objects by exact match

name__startswith

string

Getting list of objects by prefix match

count_only

boolean

Whether to only return count of objects

Defaultfalse

Responses

200

Database Table Columns

Array of object

object

database_name

string

Name of the Database

schema_name

string

Name of the Schema

table_name

string

Name of the Table

name

string

Name of the object

field

object

Column type

Example{ "column_type": "map", "key_type": { "column_type": "bool" }, "value_type": { "column_type": "bool" } }

raw_field

string

Raw description of column type

Examplemap<bool, bool>

List Database Table Columns