Apache ORC Files API

The Files API from Apache ORC — 4 operation(s) for files.

Operations 4

GET /files Apache ORC List ORC Files #
GET /files/{filePath}/schema Apache ORC Get File Schema #
GET /files/{filePath}/metadata Apache ORC Get File Metadata #
GET /files/{filePath}/statistics Apache ORC Get Column Statistics #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/apache-orc-files-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apache-orc-files-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Apache ORC Tools Conversion Files API
  description: Apache ORC is a self-describing, type-aware columnar file format for Hadoop workloads. This API represents the ORC tools REST service for reading, writing, and analyzing ORC files with support for predicate pushdown, compression, and schema evolution.
  version: 2.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    url: https://orc.apache.org/
servers:
- url: https://{host}/orc
  description: Apache ORC REST service
  variables:
    host:
      default: localhost:8080
tags:
- name: Files
paths:
  /files:
    get:
      operationId: listFiles
      summary: Apache ORC List ORC Files
      description: List ORC files available in the configured directory.
      tags:
      - Files
      responses:
        '200':
          description: List of ORC files
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileList'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /files/{filePath}/schema:
    get:
      operationId: getFileSchema
      summary: Apache ORC Get File Schema
      description: Get the schema of an ORC file including column names, types, and statistics.
      tags:
      - Files
      parameters:
      - name: filePath
        in: path
        required: true
        schema:
          type: string
        description: Path to the ORC file
        example: data/sales.orc
      responses:
        '200':
          description: ORC file schema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrcSchema'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /files/{filePath}/metadata:
    get:
      operationId: getFileMetadata
      summary: Apache ORC Get File Metadata
      description: Get metadata about an ORC file including stripes, row count, and compression info.
      tags:
      - Files
      parameters:
      - name: filePath
        in: path
        required: true
        schema:
          type: string
        description: Path to the ORC file
      responses:
        '200':
          description: ORC file metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileMetadata'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /files/{filePath}/statistics:
    get:
      operationId: getColumnStatistics
      summary: Apache ORC Get Column Statistics
      description: Get per-column statistics from an ORC file including min, max, sum, and null counts.
      tags:
      - Files
      parameters:
      - name: filePath
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Column statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ColumnStatisticsResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    StripeInfo:
      type: object
      properties:
        stripeIndex:
          type: integer
          example: 0
        offset:
          type: integer
          example: 3
        length:
          type: integer
          example: 1048576
        rowCount:
          type: integer
          example: 100000
    FileList:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/FileInfo'
    OrcSchema:
      type: object
      properties:
        typeName:
          type: string
          description: Top-level type name
          example: struct
        columns:
          type: array
          items:
            $ref: '#/components/schemas/ColumnType'
    ColumnStatisticsResponse:
      type: object
      properties:
        filePath:
          type: string
          example: data/sales.orc
        statistics:
          type: array
          items:
            $ref: '#/components/schemas/ColumnStatistics'
    ColumnType:
      type: object
      properties:
        name:
          type: string
          description: Column name
          example: customer_id
        type:
          type: string
          description: ORC type
          example: int
          enum:
          - boolean
          - tinyint
          - smallint
          - int
          - bigint
          - float
          - double
          - string
          - binary
          - timestamp
          - date
          - decimal
          - varchar
          - char
          - list
          - map
          - struct
          - union
        nullable:
          type: boolean
          example: true
        children:
          type: array
          items:
            $ref: '#/components/schemas/ColumnType'
    FileMetadata:
      type: object
      properties:
        filePath:
          type: string
          example: data/sales.orc
        fileVersion:
          type: string
          example: '0.12'
        writerVersion:
          type: string
          example: ORC_135
        compression:
          type: string
          example: ZLIB
          enum:
          - NONE
          - ZLIB
          - SNAPPY
          - LZO
          - LZ4
          - ZSTD
        compressionBlockSize:
          type: integer
          example: 262144
        rowCount:
          type: integer
          example: 1000000
        rawDataSize:
          type: integer
          example: 104857600
        numberOfStripes:
          type: integer
          example: 10
        stripes:
          type: array
          items:
            $ref: '#/components/schemas/StripeInfo'
    ColumnStatistics:
      type: object
      properties:
        columnIndex:
          type: integer
          example: 0
        columnName:
          type: string
          example: customer_id
        valueCount:
          type: integer
          example: 999500
        nullCount:
          type: integer
          example: 500
        hasMinimum:
          type: boolean
          example: true
        minimum:
          type: string
          example: '1'
        maximum:
          type: string
          example: '999999'
    FileInfo:
      type: object
      properties:
        path:
          type: string
          example: data/sales.orc
        size:
          type: integer
          description: File size in bytes
          example: 10485760
        rowCount:
          type: integer
          example: 1000000
        stripes:
          type: integer
          example: 10
x-generated-from: documentation