Apache Doris · JSON Structure

Apache Doris Table Schema Structure

Schema definition for an Apache Doris table, describing columns, keys, and partitioning.

Type: object Properties: 7 Required: 3

AnalyticsApacheDatabaseLakehouseMPPOLAPOpen SourceReal-TimeSQL

TableSchema is a JSON Structure definition published by Apache Doris, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

tableName databaseName tableType keyType columns comment replicationNum

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-doris/refs/heads/main/json-structure/apache-doris-table-schema-structure.json",
  "name": "TableSchema",
  "description": "Schema definition for an Apache Doris table, describing columns, keys, and partitioning.",
  "type": "object",
  "properties": {
    "tableName": {
      "type": "string",
      "description": "Name of the table.",
      "example": "sales_events"
    },
    "databaseName": {
      "type": "string",
      "description": "Database containing the table.",
      "example": "analytics"
    },
    "tableType": {
      "type": "string",
      "description": "Data model of the table.",
      "enum": [
        "OLAP",
        "EXTERNAL",
        "MYSQL",
        "BROKER",
        "HIVE"
      ],
      "example": "OLAP"
    },
    "keyType": {
      "type": "string",
      "description": "Key model for the table.",
      "enum": [
        "DUP_KEYS",
        "AGG_KEYS",
        "UNIQUE_KEYS"
      ],
      "example": "DUP_KEYS"
    },
    "columns": {
      "type": "array",
      "description": "List of column definitions.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Column name.",
            "example": "event_time"
          },
          "type": {
            "type": "string",
            "description": "Doris data type.",
            "example": "DATETIME"
          },
          "isKey": {
            "type": "boolean",
            "description": "Whether this column is part of the key.",
            "example": false
          },
          "nullable": {
            "type": "boolean",
            "description": "Whether this column allows NULL values.",
            "example": true
          },
          "comment": {
            "type": "string",
            "description": "Column comment.",
            "example": "Timestamp of the event"
          }
        }
      }
    },
    "comment": {
      "type": "string",
      "description": "Table comment.",
      "example": "Sales event records table"
    },
    "replicationNum": {
      "type": "int32",
      "description": "Number of data replicas.",
      "default": 3,
      "example": 3
    }
  },
  "required": [
    "tableName",
    "databaseName",
    "keyType"
  ]
}