Apache Iceberg · JSON Structure

Rest Catalog Open Api File Scan Task Structure

FileScanTask schema from Apache Iceberg REST Catalog API

Type: object Properties: 3 Required: 1
ACIDAnalyticsApacheData LakeLakehouseOpen SourceTable Format

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

Properties

data-file delete-file-references residual-filter

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-iceberg/refs/heads/main/json-structure/rest-catalog-open-api-file-scan-task-structure.json",
  "name": "FileScanTask",
  "description": "FileScanTask schema from Apache Iceberg REST Catalog API",
  "properties": {
    "data-file": {
      "$ref": "#/components/schemas/DataFile"
    },
    "delete-file-references": {
      "type": "array",
      "description": "A list of indices in the delete files array (0-based)",
      "items": {
        "type": "integer"
      }
    },
    "residual-filter": {
      "description": "An optional filter to be applied to rows in this file scan task.\nIf the residual is not present, the client must produce the residual or use the original filter.",
      "allOf": [
        {
          "$ref": "#/components/schemas/Expression"
        }
      ]
    }
  },
  "required": [
    "data-file"
  ]
}