Apache Iceberg · Schema

ContentFile

ContentFile schema from Apache Iceberg REST Catalog API

ACIDAnalyticsApacheData LakeLakehouseOpen SourceTable Format

Properties

Name Type Description
content string
file-path string
file-format object
spec-id integer
partition array A list of partition field values ordered based on the fields of the partition spec specified by the `spec-id`
file-size-in-bytes integer Total file size in bytes
record-count integer Number of records in the file
key-metadata object Encryption key metadata blob
split-offsets array List of splittable offsets
sort-order-id integer
View JSON Schema on GitHub

JSON Schema

rest-catalog-open-api-content-file-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-iceberg/refs/heads/main/json-schema/rest-catalog-open-api-content-file-schema.json",
  "title": "ContentFile",
  "description": "ContentFile schema from Apache Iceberg REST Catalog API",
  "type": "object",
  "properties": {
    "content": {
      "type": "string"
    },
    "file-path": {
      "type": "string"
    },
    "file-format": {
      "$ref": "#/components/schemas/FileFormat"
    },
    "spec-id": {
      "type": "integer"
    },
    "partition": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PrimitiveTypeValue"
      },
      "description": "A list of partition field values ordered based on the fields of the partition spec specified by the `spec-id`",
      "example": [
        1,
        "bar"
      ]
    },
    "file-size-in-bytes": {
      "type": "integer",
      "format": "int64",
      "description": "Total file size in bytes"
    },
    "record-count": {
      "type": "integer",
      "format": "int64",
      "description": "Number of records in the file"
    },
    "key-metadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BinaryTypeValue"
        }
      ],
      "description": "Encryption key metadata blob"
    },
    "split-offsets": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "List of splittable offsets"
    },
    "sort-order-id": {
      "type": "integer"
    }
  },
  "required": [
    "spec-id",
    "partition",
    "content",
    "file-path",
    "file-format",
    "file-size-in-bytes",
    "record-count"
  ]
}