This documentation is for an unreleased version of Apache Paimon. We recommend you use the latest stable version.

Schema #

The version of the schema file starts from 0 and currently retains all versions of the schema. There may be old files that rely on the old schema version, so its deletion should be done with caution.

Schema File is JSON, it includes:

1. fields: data field list, data field contains id, name, type, field id is used to support schema evolution.
2. partitionKeys: field name list, partition definition of the table, it cannot be modified.
3. primaryKeys: field name list, primary key definition of the table, it cannot be modified.
4. options: map<string, string>, no ordered, options of the table, including a lot of capabilities and optimizations.

Example #

{
  "version" : 3,
  "id" : 0,
  "fields" : [ {
    "id" : 0,
    "name" : "order_id",
    "type" : "BIGINT NOT NULL"
  }, {
    "id" : 1,
    "name" : "order_name",
    "type" : "STRING"
  }, {
    "id" : 2,
    "name" : "order_user_id",
    "type" : "BIGINT"
  }, {
    "id" : 3,
    "name" : "order_shop_id",
    "type" : "BIGINT"
  } ],
  "highestFieldId" : 3,
  "partitionKeys" : [ ],
  "primaryKeys" : [ "order_id" ],
  "options" : {
    "bucket" : "5"
  },
  "comment" : "",
  "timeMillis" : 1720496663041
}

Compatibility #

For old versions:

• version 1: should put bucket -> 1 to options if there is no bucket key.
• version 1 & 2: should put file.format -> orc to options if there is no file.format key.

DataField #

DataField represents a column of the table.

1. id: int, column id, automatic increment, it is used for schema evolution.
2. name: string, column name.
3. type: data type, it is very similar to SQL type string.
4. description: string.

Update Schema #

Updating the schema should generate a new schema file.

warehouse
└── default.db
    └── my_table
        ├── schema
            ├── schema-0
            ├── schema-1
            └── schema-2

There is a reference to schema in the snapshot. The schema file with the highest numerical value is usually the latest schema file.

Old schema files cannot be directly deleted because there may be old data files that reference old schema files. When reading table, it is necessary to rely on them for schema evolution reading.