Skip to main content
Version: Next

TableMetadataResponseSchema

columns object[]

A list of columns and their metadata

  • Array [
  • duplicates_constraintstring
    keysstring[]
    longTypestring

    The actual backend long type for the column

    namestring

    The column name

    typestring

    The column type

  • ]
  • foreignKeys object[]

    A list of foreign keys and their metadata

  • Array [
  • column_namesstring[]
    namestring

    The name of the foreign key or index

    options object
    deferrableboolean
    initiallyboolean
    matchboolean
    ondeleteboolean
    onupdateboolean
    referred_columnsstring[]
    referred_schemastring
    referred_tablestring
    typestring
  • ]
  • indexes object[]

    A list of indexes and their metadata

  • Array [
  • column_namesstring[]
    namestring

    The name of the foreign key or index

    options object
    deferrableboolean
    initiallyboolean
    matchboolean
    ondeleteboolean
    onupdateboolean
    referred_columnsstring[]
    referred_schemastring
    referred_tablestring
    typestring
  • ]
  • namestring

    The name of the table

    primaryKey object

    Primary keys metadata

    column_namesstring[]
    namestring

    The primary key index name

    typestring
    selectStarstring

    SQL select star

    TableMetadataResponseSchema
    {
    "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"
    }