superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tablemetadataresponseschema.Schema.json

{
  "schema": {
    "properties": {
      "columns": {
        "description": "A list of columns and their metadata",
        "items": {
          "properties": {
            "duplicates_constraint": { "type": "string" },
            "keys": {
              "description": "",
              "items": { "type": "string" },
              "type": "array"
            },
            "longType": {
              "description": "The actual backend long type for the column",
              "type": "string"
            },
            "name": { "description": "The column name", "type": "string" },
            "type": { "description": "The column type", "type": "string" }
          },
          "type": "object",
          "title": "TableMetadataColumnsResponse"
        },
        "type": "array"
      },
      "foreignKeys": {
        "description": "A list of foreign keys and their metadata",
        "items": {
          "properties": {
            "column_names": {
              "items": {
                "description": "A list of column names that compose the foreign key or  index",
                "type": "string"
              },
              "type": "array"
            },
            "name": {
              "description": "The name of the foreign key or index",
              "type": "string"
            },
            "options": {
              "properties": {
                "deferrable": { "type": "boolean" },
                "initially": { "type": "boolean" },
                "match": { "type": "boolean" },
                "ondelete": { "type": "boolean" },
                "onupdate": { "type": "boolean" }
              },
              "type": "object",
              "title": "TableMetadataOptionsResponse"
            },
            "referred_columns": {
              "items": { "type": "string" },
              "type": "array"
            },
            "referred_schema": { "type": "string" },
            "referred_table": { "type": "string" },
            "type": { "type": "string" }
          },
          "type": "object",
          "title": "TableMetadataForeignKeysIndexesResponse"
        },
        "type": "array"
      },
      "indexes": {
        "description": "A list of indexes and their metadata",
        "items": {
          "properties": {
            "column_names": {
              "items": {
                "description": "A list of column names that compose the foreign key or  index",
                "type": "string"
              },
              "type": "array"
            },
            "name": {
              "description": "The name of the foreign key or index",
              "type": "string"
            },
            "options": {
              "properties": {
                "deferrable": { "type": "boolean" },
                "initially": { "type": "boolean" },
                "match": { "type": "boolean" },
                "ondelete": { "type": "boolean" },
                "onupdate": { "type": "boolean" }
              },
              "type": "object",
              "title": "TableMetadataOptionsResponse"
            },
            "referred_columns": {
              "items": { "type": "string" },
              "type": "array"
            },
            "referred_schema": { "type": "string" },
            "referred_table": { "type": "string" },
            "type": { "type": "string" }
          },
          "type": "object",
          "title": "TableMetadataForeignKeysIndexesResponse"
        },
        "type": "array"
      },
      "name": { "description": "The name of the table", "type": "string" },
      "primaryKey": {
        "allOf": [
          {
            "properties": {
              "column_names": {
                "items": {
                  "description": "A list of column names that compose the primary key",
                  "type": "string"
                },
                "type": "array"
              },
              "name": {
                "description": "The primary key index name",
                "type": "string"
              },
              "type": { "type": "string" }
            },
            "type": "object",
            "title": "TableMetadataPrimaryKeyResponse"
          }
        ],
        "description": "Primary keys metadata"
      },
      "selectStar": { "description": "SQL select star", "type": "string" }
    },
    "type": "object",
    "title": "TableMetadataResponseSchema"
  },
  "schemaType": "response"
}