/database/{pk}/table/{table_name}/{schema_name}/

Get database table metadata

Responses

🟢200OK

application/json

Table metadata information

Body

columns

array[object (TableMetadataColumnsResponse) {5}]

optional

A list of columns and their metadata

duplicates_constraint

string

optional

keys

array[string]

optional

longType

string

optional

The actual backend long type for the column

name

string

optional

The column name

type

string

optional

The column type

foreignKeys

array[object (TableMetadataForeignKeysIndexesResponse) {7}]

optional

A list of foreign keys and their metadata

column_names

array[string]

optional

name

string

optional

The name of the foreign key or index

options

object (TableMetadataOptionsResponse)

optional

referred_columns

array[string]

optional

referred_schema

string

optional

referred_table

string

optional

type

string

optional

indexes

array[object (TableMetadataForeignKeysIndexesResponse) {7}]

optional

A list of indexes and their metadata

column_names

array[string]

optional

name

string

optional

The name of the foreign key or index

options

object (TableMetadataOptionsResponse)

optional

referred_columns

array[string]

optional

referred_schema

string

optional

referred_table

string

optional

type

string

optional

name

string

optional

The name of the table

primaryKey

object

optional

Primary keys metadata

column_names

array[string]

optional

name

string

optional

The primary key index name

type

string

optional

selectStar

string

optional

SQL select star

Example

{
    "columns": [
        {
            "duplicates_constraint": "string",
            "keys": [
                "string"
            ],
            "longType": "string",
            "name": "string",
            "type": "string"
        }
    ],
    "foreignKeys": [
        {
            "column_names": [
                "string"
            ],
            "name": "string",
            "options": {
                "deferrable": true,
                "initially": true,
                "match": true,
                "ondelete": true,
                "onupdate": true
            },
            "referred_columns": [
                "string"
            ],
            "referred_schema": "string",
            "referred_table": "string",
            "type": "string"
        }
    ],
    "indexes": [
        {
            "column_names": [
                "string"
            ],
            "name": "string",
            "options": {
                "deferrable": true,
                "initially": true,
                "match": true,
                "ondelete": true,
                "onupdate": true
            },
            "referred_columns": [
                "string"
            ],
            "referred_schema": "string",
            "referred_table": "string",
            "type": "string"
        }
    ],
    "name": "string",
    "primaryKey": {
        "column_names": [
            "string"
        ],
        "name": "string",
        "type": "string"
    },
    "selectStar": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠422Parameter Error

🔴500Server Error

/database/{pk}/table/{table_name}/{schema_name}/

Request

Request samples

Responses