AWS Kinesis · Schema

OrcSerDe

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StripeSizeBytes object
BlockSizeBytes object
RowIndexStride object
EnablePadding object
PaddingTolerance object
Compression object
BloomFilterColumns object
BloomFilterFalsePositiveProbability object
DictionaryKeyThreshold object
FormatVersion object
View JSON Schema on GitHub

JSON Schema

kinesis-orcserde-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OrcSerDe",
  "title": "OrcSerDe",
  "type": "object",
  "properties": {
    "StripeSizeBytes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrcStripeSizeBytes"
        },
        {
          "description": "The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB."
        }
      ]
    },
    "BlockSizeBytes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BlockSizeBytes"
        },
        {
          "description": "The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations."
        }
      ]
    },
    "RowIndexStride": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrcRowIndexStride"
        },
        {
          "description": "The number of rows between index entries. The default is 10,000 and the minimum is 1,000."
        }
      ]
    },
    "EnablePadding": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanObject"
        },
        {
          "description": "Set this to <code>true</code> to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is <code>false</code>."
        }
      ]
    },
    "PaddingTolerance": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Proportion"
        },
        {
          "description": "<p>A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.</p> <p>For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.</p> <p>Kinesis Data Firehose ignores this parameter when <a>OrcSerDe$EnablePadding</a> is <code>false</code>.</p>"
        }
      ]
    },
    "Compression": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrcCompression"
        },
        {
          "description": "The compression code to use over data blocks. The default is <code>SNAPPY</code>."
        }
      ]
    },
    "BloomFilterColumns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ListOfNonEmptyStringsWithoutWhitespace"
        },
        {
          "description": "The column names for which you want Kinesis Data Firehose to create bloom filters. The default is <code>null</code>."
        }
      ]
    },
    "BloomFilterFalsePositiveProbability": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Proportion"
        },
        {
          "description": "The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1."
        }
      ]
    },
    "DictionaryKeyThreshold": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Proportion"
        },
        {
          "description": "Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1."
        }
      ]
    },
    "FormatVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrcFormatVersion"
        },
        {
          "description": "The version of the file to write. The possible values are <code>V0_11</code> and <code>V0_12</code>. The default is <code>V0_12</code>."
        }
      ]
    }
  },
  "description": "A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see <a href=\"https://orc.apache.org/docs/\">Apache ORC</a>."
}